Lists all endpoints assigned to the contract and group where you created the collection. The API Endpoints API manages this operation's response data format.

Path Params
int64
required

Identifies the collection. Run the List key collections operation to select one.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Responses

Response body
object
array of objects
required

Throttling counter's endpoints.

endpoints*
object
uri
required

URL path that serves as a root prefix for all resources resourcePath values. This is / if empty. Don't append a / character to the path. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

int64
required
≥ 0

Identifies the endpoint.

string
required
length ≥ 1

Name of the endpoint, unique within the account.

object | null

Specifies an endpoint version activation. Appears as null in responses until you activate it on the network.

object | null

Specifies an endpoint version activation. Appears as null in responses until you activate it on the network.

boolean
required

Read-only Indicates if the API endpoint is currently protected by an API key.

array of objects

Resource objects related to the endpoint.

resources
object
boolean
required

Makes the resource private. API consumers can access private resources only if they identify with an appropriate API key.

array of objects

Method objects related to the resource.

methods
object
boolean
required

Makes the resource method private. API consumers can access resources with private method only if they identify with an appropriate API key.

string
required
length ≥ 1

Core HTTP method to which the resource may respond, either GET, POST, PUT, DELETE, HEAD, PATCH, or OPTIONS.

int64
required
≥ 0

Identifies the resource's allowed method.

int64
required
≥ 0

Identifies the resource's method across all endpoint versions.

object | null

Specifies an endpoint version activation. Appears as null in responses until you activate it on the network.

object | null

Specifies an endpoint version activation. Appears as null in responses until you activate it on the network.

uri
required

URL path relative to the hostnames on which the resource resides.

int64
required
≥ 0

Identifies the resource.

int64
required
≥ 0

Identifies the resource across different endpoint versions.

string
required
length ≥ 1

Name of the resource.

object | null

Specifies an endpoint version activation. Appears as null in responses until you activate it on the network.

object | null

Specifies an endpoint version activation. Appears as null in responses until you activate it on the network.

int64
required
≥ 1

Endpoint version number.

Language
Authentication
URL