Akamai API Security · JSON Structure

Api Security Problem Details Structure

Details the errors you can receive.

Type: object Properties: 6 Required: 5
API DiscoveryAPI SecurityCloud SecurityPosture ManagementRuntime ProtectionThreat Protection

problem-details is a JSON Structure definition published by Akamai API Security, describing 6 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

detail fieldErrors instance status name type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai-api-security/refs/heads/main/json-structure/api-security-problem-details-structure.json",
  "name": "problem-details",
  "description": "Details the errors you can receive.",
  "type": "object",
  "properties": {
    "detail": {
      "description": "The detailed error message.",
      "type": "string"
    },
    "fieldErrors": {
      "additionalProperties": {
        "description": "Fields that provide additional details about the problem.",
        "type": "string"
      },
      "description": "Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.",
      "type": "object"
    },
    "instance": {
      "description": "The non-referenceable URI that indicates the error instance.",
      "example": "https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
      "type": "string"
    },
    "status": {
      "description": "The HTTP status code.",
      "example": 404,
      "type": "int32"
    },
    "name": {
      "description": "The error title.",
      "example": "Not Found",
      "type": "string"
    },
    "type": {
      "description": "The URL for the error type.",
      "example": "https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND",
      "type": "string"
    }
  },
  "required": [
    "title",
    "type",
    "detail",
    "instance",
    "status"
  ],
  "additionalProperties": true
}