Akamai · Example Payload

Akamai Get Api Endpoints Example

CDNCloudEdge ComputingNetworksPlatformSecurity

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

Raw ↑ 
{
  "operationId": "get-api-endpoints",
  "method": "GET",
  "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-endpoints",
  "summary": "List API endpoints",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "apiEndpoints": [
          {
            "apiEndPointHosts": [
              "sg.akamai.com"
            ],
            "basePath": "/v1/orders",
            "id": 619183,
            "name": "Orders",
            "productionVersion": {
              "status": "ACTIVE",
              "versionNumber": 1
            },
            "requestConstraintsEnabled": false,
            "stagingVersion": {
              "status": "ACTIVE",
              "versionNumber": 1
            }
          },
          {
            "apiEndPointHosts": [
              "sg.akamai.com"
            ],
            "basePath": "/v1/catalog",
            "id": 624913,
            "name": "Catalog",
            "productionVersion": {
              "status": "ACTIVE",
              "versionNumber": 1
            },
            "requestConstraintsEnabled": true,
            "stagingVersion": {
              "status": "ACTIVE",
              "versionNumber": 1
            }
          }
        ]
      }
    },
    {
      "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": "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"
      }
    }
  ]
}