Kong · Schema

Error

standard error

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
status integer The HTTP status code of the error. Useful when passing the response body to child properties in a frontend UI. Must be returned as an integer.
title string A short, human-readable summary of the problem. It should not change between occurences of a problem, except for localization. Should be provided as "Sentence case" for direct use in the UI.
type string The error type.
instance string Used to return the correlation ID back to the user, in the format kong:trace:. This helps us find the relevant logs when a customer reports an issue.
detail string A human readable explanation specific to this occurence of the problem. This field may contain request/entity data to help the user understand what went wrong. Enclose variable values in square bracke
View JSON Schema on GitHub

JSON Schema

kong-baseerror-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BaseError",
  "title": "Error",
  "description": "standard error",
  "type": "object",
  "properties": {
    "status": {
      "description": "The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n",
      "type": "integer",
      "readOnly": true
    },
    "title": {
      "description": "A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n",
      "type": "string",
      "readOnly": true
    },
    "type": {
      "description": "The error type.",
      "type": "string",
      "readOnly": true
    },
    "instance": {
      "description": "Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n",
      "type": "string",
      "readOnly": true
    },
    "detail": {
      "description": "A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n",
      "type": "string",
      "readOnly": true
    }
  },
  "required": [
    "status",
    "title",
    "instance",
    "detail"
  ]
}