NGINX · JSON Structure

Plus Http Api Nginx Error Structure

nginx error object.

Type: object Properties: 0
API GatewayCachingCloud NativeLoad BalancerOpen SourceReverse ProxyWeb Server

Error is a JSON Structure definition published by NGINX. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "Error",
  "description": "nginx error object.\n",
  "type": "object",
  "members": {
    "error": {
      "type": "object",
      "members": {
        "status": {
          "description": "HTTP error code.",
          "type": "int32",
          "example": 200
        },
        "text": {
          "description": "Error description.",
          "type": "string",
          "example": "example-text"
        },
        "code": {
          "description": "Internal nginx error code.",
          "type": "string",
          "example": 200
        }
      },
      "example": {}
    },
    "request_id": {
      "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.",
      "type": "string",
      "example": "example-request_id"
    },
    "href": {
      "description": "Link to reference documentation.",
      "type": "string",
      "example": "example-href"
    }
  }
}