Akamai · Example Payload

Akamai Get Endpoints Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Endpoints Example is an example object payload from Akamai, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "get-endpoints",
  "method": "GET",
  "path": "/endpoints",
  "summary": "List endpoints",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "page": 8,
        "pageSize": 1,
        "totalSize": 15,
        "apiEndPoints": [
          {
            "apiEndPointId": 574127,
            "apiEndPointLocked": false,
            "apiEndPointName": "Bookstore API Premium",
            "apiEndPointScheme": "http/https",
            "basePath": "/bookstore-premium",
            "clonedFromVersion": 1,
            "consumeType": "any",
            "contractId": "K-0N7RAK71",
            "createDate": "2019-06-12T13:06:52+0000",
            "createdBy": "jsmith",
            "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.",
            "endpointHidden": true,
            "groupId": 44681,
            "positiveConstrainsEnabled": true,
            "protectedByApiKey": true,
            "responseConstraintsEnabled": true,
            "updateDate": "2019-06-12T13:06:52+0000",
            "updatedBy": "bookstore_admin",
            "versionHidden": true,
            "versionNumber": 2,
            "apiCategoryIds": [],
            "apiEndPointHosts": [
              "bookstore.api.akamai.com"
            ],
            "availableActions": [
              "CLONE_ENDPOINT",
              "SHOW_ENDPOINT",
              "COMPARE_ENDPOINT",
              "ACTIVATE_ON_STAGING",
              "ACTIVATE_ON_PRODUCTION"
            ],
            "pii": {
              "types": [
                "PERSONAL_EMAIL"
              ]
            },
            "productionVersion": {
              "status": null,
              "versionNumber": null
            },
            "stagingVersion": {
              "status": null,
              "versionNumber": null
            },
            "apiResourceBaseInfo": [
              {
                "apiResourceClonedFromId": null,
                "apiResourceId": 2926712,
                "apiResourceLogicId": 118435,
                "apiResourceName": "/books/{bookId}",
                "createDate": "2019-06-12T13:06:52+0000",
                "createdBy": "tyamada",
                "description": "A book item within the bookstore API.",
                "link": null,
                "lockVersion": 0,
                "private": false,
                "resourcePath": "/books/{bookId}",
                "updateDate": "2019-06-12T13:06:52+0000",
                "updatedBy": "bookstore_admin"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "/api-definitions/v2/endpoints?pageSize=2&page=8",
            "rel": "self"
          },
          {
            "href": "/api-definitions/v2/endpoints?pageSize=2&page=9",
            "rel": "next"
          },
          {
            "href": "/api-definitions/v2/endpoints?pageSize=2&page=7",
            "rel": "previous"
          }
        ]
      }
    }
  ]
}