List endpoints

get

https://{hostname}/api-definitions/v2/endpoints

Lists the available API endpoints, with results optionally paginated, sorted, and filtered. If no endpoints are available, the operation responds with an empty array.

Query Params

piiOnly

boolean

Defaults to false

Return only endpoints with personally identifiable information (PII), false by default.

page

integer

Defaults to 1

The page number index, starting at the default value of 1.

pageSize

integer

Defaults to 25

The number of endpoints on each page of results, 25 by default.

category

string

Filters endpoints by the specified apiCategoryName, including the __UNCATEGORIZED__ keyword.

contains

string

The search query substring criteria matching the endpoint's name, description, basePath, apiCategoryName, and resourcePath.

sortBy

string

enum

Defaults to name

Enum The field to sort endpoints by, either the updateDate or the API name that corresponds to the apiEndPointName in data. The default is name.

Allowed:

sortOrder

string

enum

Defaults to asc

Enum The sort order, either desc for descending or the default asc for ascending.

Allowed:

versionPreference

string

enum

Defaults to LAST_UPDATED

Enum The preference for selecting the endpoint version to return. By default the API returns the LAST_UPDATED version. If you set the preference to ACTIVATED_FIRST, the API first attempts to return the version currently active on the production network. If such version doesn't exist, the API attempts to return the version currently active on the staging network. If both of these checks fail, the API returns the last updated version.

Allowed:

show

string

enum

Defaults to ALL

Enum The type of endpoints to return based on their visibility status. By default the API returns ALL endpoints. You can instead decide to return ONLY_VISIBLE endpoints, or ONLY_HIDDEN endpoints. Run the Show an endpoint and Hide an endpoint operations to control which endpoints are listed.

Allowed:

contractId

string

Filters endpoints to a specific contract. You need to specify this along with a groupId.

groupId

integer

Filters endpoints to a specific group. You need to specify this along with a contractId.

accountSwitchKey

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Response body

object

A collection of requested endpoints.

apiEndPoints

array of objects

The returned endpoint objects.

apiEndPoints

object

apiCategoryIds

array of integers | null

The category identifiers that apply to this endpoint. The value is null for uncategorized endpoints.

apiEndPointHosts

array of strings

The hostnames that may receive traffic for the endpoint. You need at least one hostname to activate the endpoint.

apiEndPointId

integer

The unique identifier for the endpoint.

apiEndPointLocked

boolean

Whether the endpoint version is read-only.

apiEndPointName

string

required

The name of the endpoint, unique within the account.

apiEndPointScheme

string

enum

The URL scheme to which the endpoint may respond, either http, https, or http/https for both.

http https http/https

apiEndPointVersion

integer

The unique identifier for the endpoint version.

apiResourceBaseInfo

array of objects

Resource objects assigned to the endpoint.

apiResourceBaseInfo

object

apiResourceClonedFromId

integer | null

For cloned resources, the unique identifier for the source resource.

apiResourceId

integer

The unique identifier for the resource.

apiResourceLogicId

integer

The unique identifier for the resource across different endpoint versions.

apiResourceName

string

The name of the resource.

createDate

date-time

The ISO 8601 timestamp indicating when you created the resource.

createdBy

string

The identifier for the user who created the resource.

description

string | null

The description to clarify the resource's function within the API. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as null.

link

string | null

The location of the navigable resource within this API, for use by API clients.

lockVersion

integer

The identifier for the last modification of an endpoint version, used for optimistic locking. See Concurrency control for details.

private

boolean

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

resourcePath

string

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

updateDate

date-time

The ISO 8601 timestamp indicating when you last modified the resource.

updatedBy

string

The identifier for the user who last modified the resource.

apiVersionInfo

object | null

A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.

availableActions

array of strings

Available actions that you can perform on the endpoint depending on its versions' activation status.

DELETE CLONE_ENDPOINT COMPARE_ENDPOINT COMPARE_AAG_SETTINGS COMPARE_RAPID_SETTINGS EDIT_ENDPOINT_DEFINITION ACTIVATE_ON_STAGING ACTIVATE_ON_PRODUCTION DEACTIVATE_ON_STAGING DEACTIVATE_ON_PRODUCTION HIDE_ENDPOINT SHOW_ENDPOINT

basePath

string | null

The 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.

caseSensitive

boolean

Whether the URLs and parameters within the endpoint are case sensitive.

clonedFromVersion

integer

For cloned endpoints, the unique identifier for the source endpoint version.

consumeType

string

enum

The content type the endpoint exchanges, either json, xml, json/xml for dual-format APIs, any, or none.

json xml json/xml any none

contractId

string

The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.

createDate

date-time

The ISO 8601 timestamp indicating when you created the endpoint.

createdBy

string

The identifier for the user who created the resource.

description

string | null

The description of the endpoint. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

endpointHidden

boolean

Indicates whether the endpoint is hidden. You can't activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the Show an endpoint operation.

groupId

integer

The unique identifier for the group in the Control Center portal under which you activated security and delivery settings for this API.

isGraphQL

boolean

Whether the endpoint uses GraphQL to deliver structured content to clients.

lockVersion

integer

The identifier for the last modification of an endpoint version, used for optimistic locking. See Concurrency control for details.

pii

object

Personally identifiable information. See API concepts for more information.

positiveConstrainsEnabled

boolean

Enables App & API Protector firewall policies for the endpoint.

productionVersion

object

An endpoint version's activation status on the production network.

responseConstraintsEnabled

boolean

Enables App & API Protector firewall policies for the responses.

source

object | null

The import file used to create the endpoint.

stagingVersion

object

An endpoint version's activation status on the staging network.

updateDate

date-time

The ISO 8601 timestamp indicating when you last modified the endpoint.

updatedBy

string

The identifier for the user who last modified the resource.

versionHidden

boolean

Indicates whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the Show a version operation.

versionNumber

integer

The endpoint version number.

page

integer

≥ 1

The number of the current page with results.

pageSize

integer

The number of endpoints on each page with results.

totalSize

integer

The total number of endpoints available in the returned set.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/api-definitions/v2/endpoints \
3
     --header 'accept: application/json'


xxxxxxxxxx
84
}
1
{
2
  "apiEndPoints": [
3
    {
4
      "apiCategoryIds": [],
5
      "apiEndPointHosts": [
6
        "bookstore.api.akamai.com"
7
      ],
8
      "apiEndPointId": 574127,
9
      "apiEndPointLocked": false,
10
      "apiEndPointName": "Bookstore API Premium",
11
      "apiEndPointScheme": "http/https",
12
      "apiResourceBaseInfo": [
13
        {
14
          "apiResourceClonedFromId": null,
15
          "apiResourceId": 2926712,
16
          "apiResourceLogicId": 118435,
17
          "apiResourceName": "/books/{bookId}",
18
          "createDate": "2019-06-12T13:06:52+0000",
19
          "createdBy": "bookstore_admin",
20
          "description": "A book item within the bookstore API.",
21
          "link": null,
22
          "lockVersion": 0,
23
          "private": false,
24
          "resourcePath": "/books/{bookId}",
25
          "updateDate": "2019-06-12T13:06:52+0000",
26
          "updatedBy": "bookstore_admin"
27
        }
28
      ],
29
      "availableActions": [
30
        "CLONE_ENDPOINT",
31
        "SHOW_ENDPOINT",
32
        "COMPARE_ENDPOINT",
33
        "ACTIVATE_ON_STAGING",
34
        "ACTIVATE_ON_PRODUCTION"
35
      ],
36
      "basePath": "/bookstore-premium",
37
      "clonedFromVersion": 1,
38
      "consumeType": "any",
39
      "contractId": "C-0N7RAC7",
40
      "createDate": "2019-06-12T13:06:52+0000",
41
      "createdBy": "bookstore_admin",
42
      "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.",
43
      "endpointHidden": true,
44
      "groupId": 12345,
45
      "pii": {
46
        "types": [
47
          "PERSONAL_EMAIL"
48
        ]
49
      },

200Lists API Endpoints you can access.

403Forbidden. You don't have permission to get the API endpoint list.