Akamai · Example Payload

Akamai Get Discovered Api Endpoints Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Discovered Api 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

{
  "operationId": "get-discovered-api-endpoints",
  "method": "GET",
  "path": "/api-discovery/host/{hostname}/basepath/{basePath}/endpoints",
  "summary": "List discovered API endpoints",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "apis": [
          {
            "apiEndPointId": 613101,
            "apiEndPointName": "Access Lambda Live",
            "latest": {
              "basePath": "/access-api/v1",
              "version": 3
            },
            "production": {
              "basePath": "/access-api/v1",
              "version": 1
            },
            "staging": {
              "basePath": "/access-api/v1",
              "version": 2
            }
          },
          {
            "apiEndPointId": 613102,
            "apiEndPointName": "New Broadcast API",
            "latest": {
              "basePath": "/access-api",
              "version": 8
            },
            "production": {
              "basePath": "/access-api",
              "version": 4
            },
            "staging": {
              "basePath": "/access-api",
              "version": 5
            }
          }
        ]
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "detail": "The request could not be understood by the server due to malformed syntax.",
        "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
        "status": 400,
        "title": "Bad Request",
        "type": "https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST"
      }
    },
    {
      "status": "403",
      "contentType": "application/problem+json",
      "example": {
        "detail": "You do not have the necessary access to perform this operation or the requested resource cannot be modified",
        "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
        "status": 403,
        "title": "Forbidden",
        "type": "https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED"
      }
    },
    {
      "status": "404",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The requested resource is not found",
        "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
        "status": 404,
        "title": "Not Found",
        "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND"
      }
    },
    {
      "status": "500",
      "contentType": "application/problem+json",
      "example": {
        "detail": "Internal Server Error",
        "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no",
        "status": 500,
        "title": "Internal Server Error",
        "type": "internal_server_error"
      }
    }
  ]
}