Akamai · Example Payload
Akamai Put Error Response Setting Example

CDNCloudEdge ComputingNetworksPlatformSecurity
Akamai Put Error Response Setting 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": "put-error-response-setting",
  "method": "PUT",
  "path": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/error-responses",
  "summary": "Edit error response settings",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "API_KEY_FORBIDDEN": {
          "body": "{\"title\":\"The API key you provided does not have access to the requested resource.\" }",
          "statusCode": 403,
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/problem+json"
            }
          ]
        },
        "API_KEY_INVALID": {
          "body": "{\"title\":\"The API key you provided does not exist.\" }",
          "statusCode": 401,
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/problem+json"
            }
          ]
        },
        "JWT_CLAIM_VALUE_INVALID": {
          "body": "{\"title\":\"The JWT claim value did not pass the JWT validation.\" }",
          "statusCode": 401,
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/problem+json"
            }
          ]
        },
        "JWT_SIGNATURE_INVALID": {
          "body": "{\"title\":\"The JSON web signature in JWT did not pass the JWT validation.\" }",
          "statusCode": 401,
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/problem+json"
            }
          ]
        },
        "QUOTA_EXCEEDED": {
          "body": "{\"title\":\"The quota limit for the API key you provided has been exceeded during the current time period.\" }",
          "statusCode": 429,
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/problem+json"
            }
          ]
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "API_KEY_FORBIDDEN": {
          "body": "{\"title\":\"The API key you provided does not have access to the requested resource.\" }",
          "overrideDefaults": false,
          "statusCode": 403,
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/problem+json"
            }
          ]
        },
        "API_KEY_INVALID": {
          "body": "{\"title\":\"The API key you provided does not exist.\" }",
          "overrideDefaults": false,
          "statusCode": 401,
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/problem+json"
            }
          ]
        },
        "JWT_CLAIM_VALUE_INVALID": {
          "body": "{\"title\":\"The JWT claim value did not pass the JWT validation.\" }",
          "overrideDefaults": false,
          "statusCode": 401,
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/problem+json"
            }
          ]
        },
        "JWT_SIGNATURE_INVALID": {
          "body": "{\"title\":\"The JSON web signature in JWT did not pass the JWT validation.\" }",
          "overrideDefaults": false,
          "statusCode": 401,
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/problem+json"
            }
          ]
        },
        "QUOTA_EXCEEDED": {
          "body": "{\"title\":\"The quota limit for the API key you provided has been exceeded during the current time period.\" }",
          "overrideDefaults": false,
          "statusCode": 429,
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/problem+json"
            }
          ]
        }
      }
    }
  ]
}