NGINX · Schema

Error

nginx error object.

API GatewayCachingCloud NativeLoad BalancerOpen SourceReverse ProxyWeb Server

Properties

Name Type Description
error object
request_id string The ID of the request, equals the value of the $request_id variable.
href string Link to reference documentation.
View JSON Schema on GitHub

JSON Schema

plus-http-api-nginx-error-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-schema/plus-http-api-nginx-error-schema.json",
  "title": "Error",
  "description": "nginx error object.\n",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "description": "HTTP error code.",
          "example": 200
        },
        "text": {
          "type": "string",
          "description": "Error description.",
          "example": "example-text"
        },
        "code": {
          "type": "string",
          "description": "Internal nginx error code.",
          "example": 200
        }
      },
      "example": {}
    },
    "request_id": {
      "type": "string",
      "description": "The ID of the request, equals the value of the <a href=\"https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_id\">$request_id</a> variable.",
      "example": "example-request_id"
    },
    "href": {
      "type": "string",
      "description": "Link to reference documentation.",
      "example": "example-href"
    }
  }
}