Akamai · Example Payload

Akamai Get Item Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Item 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-item",
  "method": "GET",
  "path": "/networks/{network}/namespaces/{namespaceId}/groups/{groupId}/items/{itemId}",
  "summary": "Akamai Read an Item",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "currency": "\u20ac",
        "flag": "/germany.png",
        "name": "Germany"
      }
    },
    {
      "status": "400",
      "contentType": "application/problem+json",
      "example": {
        "detail": "Key must only use a string that matches A-Z a-z 0-9 _ or -..",
        "errorCode": "EKV_9000",
        "instance": "/edgekv/error-instances/66344166-567c-4158-95b2-07d6127b8b75",
        "status": 400,
        "title": "Bad Request",
        "type": "/edgekv/error-types/edgekv-bad-request",
        "additionalDetail": {
          "requestId": "a4c461e09bf602be"
        }
      }
    },
    {
      "status": "404",
      "contentType": "application/problem+json",
      "example": {
        "detail": "Item 'item1' or group 'group1' was not found in the database.",
        "errorCode": "EKV_9000",
        "instance": "/edgekv/error-instances/d914f64f-020e-465c-ae70-e456fec8870a",
        "status": 404,
        "title": "Not Found",
        "type": "/edgekv/error-types/edgekv-not-found",
        "additionalDetail": {
          "requestId": "ac1961e09b0e00a5"
        }
      }
    },
    {
      "status": "429",
      "contentType": "application/problem+json",
      "example": {
        "detail": "Your request has been denied: 364 hits per second too high. limit set at 73. Please try again soon.",
        "errorCode": "EKV_9100",
        "instance": "/edgekv/error-instances/80f9503f-633e-4412-9393-62f329868911",
        "status": 429,
        "title": "Too Many Requests",
        "type": "/edgekv/error-types/edgekv-too-many-requests",
        "additionalDetail": {
          "requestId": "16fc97b7cb0ee4dd"
        }
      }
    },
    {
      "status": "500",
      "contentType": "application/problem+json",
      "example": {
        "detail": "An internal error occurred.",
        "errorCode": "EKV_0000",
        "instance": "/edgekv/error-instances/cdb7767c-817e-4805-9f28-0816eefa0ba8",
        "status": 500,
        "title": "Internal Server Error",
        "type": "/edgekv/error-types/edgekv-internal-server-error",
        "additionalDetail": {
          "requestId": "cd9b61e08148009b"
        }
      }
    }
  ]
}