Akamai · Example Payload

Akamai Post Invalidate Cpcode Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Post Invalidate Cpcode 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": "post-invalidate-cpcode",
  "method": "POST",
  "path": "/invalidate/cpcode/{network}",
  "summary": "Invalidate by CP code",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "objects": [
          12345,
          98765
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "example": {
        "detail": "Request accepted",
        "estimatedSeconds": 5,
        "httpStatus": 201,
        "purgeId": "edcp-NZbXzFpHBjcJeryhw6PVgG",
        "supportId": "edcp-NZbXzFpHBjcJeryhw6PVgG"
      }
    },
    {
      "status": "400",
      "contentType": "application/api-problem+json",
      "example": {
        "describedBy": "https://techdocs.akamai.com/purge-cache/reference/api-errors",
        "detail": "Invalid or malformed hostname",
        "httpStatus": 400,
        "supportId": "edcp-NZbXzFpHBjcJeryhw6PVgG",
        "title": "bad URL hostname"
      }
    },
    {
      "status": "403",
      "contentType": "application/api-problem+json",
      "example": {
        "describedBy": "https://techdocs.akamai.com/purge-cache/reference/api-errors",
        "detail": "http://fpj-test.bad-ideas2.org/",
        "httpStatus": 403,
        "supportId": "edcp-NZbXzFpHBjcJeryhw6PVgG",
        "title": "unauthorized arl"
      }
    },
    {
      "status": "429",
      "contentType": "application/api-problem+json",
      "example": {
        "describedBy": "https://techdocs.akamai.com/purge-cache/reference/api-errors",
        "detail": "",
        "httpStatus": 429,
        "rateLimit": 300,
        "rateLimitCurrentRequestSize": 5,
        "rateLimitRemaining": 1,
        "supportId": "edcp-NZbXzFpHBjcJeryhw6PVgG",
        "title": "CPCODE Rate Limit exceeded"
      }
    },
    {
      "status": "500",
      "contentType": "application/api-problem+json",
      "example": {
        "describedBy": "https://techdocs.akamai.com/purge-cache/reference/api-errors",
        "detail": "If problem persists over multiple requests, please contact Customer Care",
        "httpStatus": 500,
        "supportId": "edcp-NZbXzFpHBjcJeryhw6PVgG",
        "title": "internal error"
      }
    }
  ]
}