Akamai · Schema

response

V3 Purge response schema.

CDNCloudEdge ComputingNetworksPlatformSecurity

Properties

Name	Type	Description
describedBy	string	A URL that describes the API's error response.
detail	string	Detailed information about the HTTP status code returned with the response.
estimatedSeconds	integer	The estimated number of seconds before the purge is to complete.
httpStatus	integer	The HTTP code that indicates the status of the request to invalidate or purge content. Successful requests yield a `201` code.
purgeId	string	Unique identifier for the purge request.
supportId	string	Identifier to provide Akamai Technical Support if issues arise.
title	string	Describes the response type, for example, `Rate Limit exceeded`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai/main/json-schema/fast-purge-response-schema.json",
  "title": "response",
  "additionalProperties": true,
  "description": "V3 Purge response schema.",
  "properties": {
    "describedBy": {
      "description": "A URL that describes the API's error response.",
      "type": "string"
    },
    "detail": {
      "description": "Detailed information about the HTTP status code returned with the response.",
      "type": "string"
    },
    "estimatedSeconds": {
      "description": "The estimated number of seconds before the purge is to complete.",
      "type": "integer"
    },
    "httpStatus": {
      "description": "The HTTP code that indicates the status of the request to invalidate or purge content. Successful requests yield a `201` code.",
      "type": "integer"
    },
    "purgeId": {
      "description": "Unique identifier for the purge request.",
      "type": "string"
    },
    "supportId": {
      "description": "Identifier to provide Akamai Technical Support if issues arise.",
      "type": "string"
    },
    "title": {
      "description": "Describes the response type, for example, `Rate Limit exceeded`.",
      "type": "string"
    }
  },
  "required": [
    "httpStatus",
    "supportId",
    "detail"
  ],
  "type": "object",
  "x-akamai": {
    "file-path": "schemas/response.yaml"
  }
}