Apigee · Schema

Status

The Status type defines a logical error model.

Advanced API SecurityAgentic AIAnalyticsAPI GatewayAPI GovernanceAPI HubAPI ManagementDeveloper PortalEnterpriseGenerative AIHybridIntegrationsMicroservicesMCPModel Context ProtocolMonetization

Properties

Name Type Description
code integer The status code.
message string A developer-facing error message.
details array A list of messages that carry the error details.
View JSON Schema on GitHub

JSON Schema

apigee-status-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Status",
  "title": "Status",
  "type": "object",
  "description": "The Status type defines a logical error model.",
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32",
      "description": "The status code."
    },
    "message": {
      "type": "string",
      "description": "A developer-facing error message."
    },
    "details": {
      "type": "array",
      "description": "A list of messages that carry the error details.",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    }
  }
}