Akamai · Schema

http-problem-details

Collects data for errors.

CDNCloudEdge ComputingNetworksPlatformSecurity

Properties

Name	Type	Description
detail	string	Detail error message.
errors	array	A nested problem object.
instance	string	The non-referencable URI that indicates the error instance.
status	integer	The HTTP status code.
title	string	The name of the error.
type	string	The URL for the error type.

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/site-shield-http-problem-details-schema.json",
  "title": "http-problem-details",
  "additionalProperties": true,
  "description": "Collects data for errors.",
  "properties": {
    "detail": {
      "description": "Detail error message.",
      "type": "string"
    },
    "errors": {
      "description": "A nested problem object.",
      "items": {
        "description": "A nested problem object.",
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/http-problem-details-nested.yaml"
        }
      },
      "type": "array"
    },
    "instance": {
      "description": "The non-referencable URI that indicates the error instance.",
      "type": "string"
    },
    "status": {
      "description": "The HTTP status code.",
      "example": 404,
      "type": "integer"
    },
    "title": {
      "description": "The name of the error.",
      "example": "Not found.",
      "type": "string"
    },
    "type": {
      "description": "The URL for the error type.",
      "type": "string"
    }
  },
  "required": [
    "type",
    "title"
  ],
  "type": "object",
  "x-akamai": {
    "file-path": "schemas/http-problem-details.yaml"
  }
}