NGINX · JSON Structure

Plus Http Api Nginx Object Structure

General information about nginx:

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

nginx 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": "nginx",
  "description": "General information about nginx:\n",
  "type": "object",
  "members": {
    "version": {
      "description": "Version of nginx.",
      "type": "string",
      "example": "1.25.3"
    },
    "build": {
      "description": "Name of nginx build.",
      "type": "string",
      "example": "nginx-plus-r32"
    },
    "address": {
      "description": "The address of the server that accepted status request.",
      "type": "string",
      "example": "10.0.0.1"
    },
    "generation": {
      "description": "The total number of configuration <a href=\"https://nginx.org/en/docs/control.html#reconfiguration\">reloads</a>.",
      "type": "int32",
      "example": 8
    },
    "load_timestamp": {
      "description": "Time of the last reload of configuration, in the ISO 8601 format with millisecond resolution.",
      "type": "string",
      "example": "2026-04-21T10:30:00.000Z"
    },
    "timestamp": {
      "description": "Current time in the ISO 8601 format with millisecond resolution.",
      "type": "string",
      "example": "2026-04-21T10:30:00.000Z"
    },
    "pid": {
      "description": "The ID of the worker process that handled status request.",
      "type": "int32",
      "example": 4521
    },
    "ppid": {
      "description": "The ID of the master process that started the <a href=\"https://nginx.org/en/docs/http/ngx_http_status_module.html#pid\">worker process</a>.",
      "type": "int32",
      "example": 4519
    }
  },
  "example": {
    "nginx": {
      "version": "1.21.6",
      "build": "nginx-plus-r27",
      "address": "206.251.255.64",
      "generation": 6,
      "load_timestamp": "2022-06-28T11:15:44.467000+00:00",
      "timestamp": "2022-06-28T09:26:07.305000+00:00",
      "pid": 32212,
      "ppid": 32210
    }
  }
}