NGINX

NGINX Slabs API

The Slabs API from NGINX — 2 operation(s) for slabs.

GitHub OpenAPI

Operations 3

GET /slabs/ NGINX Return Status of All Slabs #
GET /slabs/{slabZoneName} NGINX Return Status of a Slab #
DELETE /slabs/{slabZoneName} NGINX Reset Slab Statistics #

Documentation

📖
Documentation
https://nginx.org/en/docs/http/ngx_http_api_module.html
📖
APIReference
https://nginx.org/en/docs/http/ngx_http_api_module.html#api
📖
Documentation
https://nginx.org/en/docs/http/ngx_http_stub_status_module.html
📖
Documentation
https://nginx.org/en/docs/njs/
📖
APIReference
https://nginx.org/en/docs/njs/reference.html
📖
GettingStarted
https://nginx.org/en/docs/njs/install.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/openapi/nginx-slabs-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/nginx/njs

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-ld/nginx-plus-http-api-context.jsonld
🔗
SDKs
https://github.com/nginx/nginx-plus-go-client
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-ld/nginx-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/nginx-slabs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nginx-slabs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '9.0'
  title: NGINX Plus REST Slabs API
  description: NGINX Plus REST [API](https://nginx.org/en/docs/http/ngx_http_api_module.html) provides access to NGINX Plus status information, on-the-fly configuration of upstream servers and key-value pairs management for [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html).
servers:
- url: /api/9
tags:
- name: Slabs
paths:
  /slabs/:
    get:
      tags:
      - Slabs
      summary: NGINX Return Status of All Slabs
      description: Returns status of slabs for each shared memory zone with slab allocator.
      operationId: getSlabs
      parameters:
      - in: query
        name: fields
        description: Limits which fields of slab zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.
        x-example: ''
        schema:
          type: string
      responses:
        '200':
          description: Success
          x-microcks-refs:
          - name: getSlabs200Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxSlabZoneMap'
              example:
                http_cache:
                  pages:
                    used: 2
                    free: 2452
                  slots:
                    8:
                      used: 0
                      free: 0
                      reqs: 0
                      fails: 0
                    16:
                      used: 0
                      free: 0
                      reqs: 0
                      fails: 0
                    32:
                      used: 1
                      free: 126
                      reqs: 1
                      fails: 0
                    64:
                      used: 2
                      free: 62
                      reqs: 2
                      fails: 0
                    128:
                      used: 0
                      free: 0
                      reqs: 0
                      fails: 0
                dns-backends:
                  pages:
                    used: 1143
                    free: 2928
                  slots:
                    8:
                      used: 0
                      free: 0
                      reqs: 0
                      fails: 0
                    16:
                      used: 0
                      free: 0
                      reqs: 0
                      fails: 0
                    32:
                      used: 0
                      free: 0
                      reqs: 0
                      fails: 0
                    64:
                      used: 1
                      free: 63
                      reqs: 1
                      fails: 0
                    128:
                      used: 0
                      free: 0
                      reqs: 0
                      fails: 0
                    256:
                      used: 18078
                      free: 178
                      reqs: 1635736
                      fails: 0
        '404':
          description: Unknown version (*UnknownVersion*)
          x-microcks-refs:
          - name: getSlabs404Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
              example:
                error: {}
                request_id: example-request_id
                href: example-href
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /slabs/{slabZoneName}:
    parameters:
    - name: slabZoneName
      in: path
      description: The name of the shared memory zone with slab allocator.
      required: true
      x-example: example_slabZoneName
      schema:
        type: string
    get:
      tags:
      - Slabs
      summary: NGINX Return Status of a Slab
      description: Returns status of slabs for a particular shared memory zone with slab allocator.
      operationId: getSlabZone
      parameters:
      - in: query
        name: fields
        description: Limits which fields of the slab zone will be output.
        x-example: ''
        schema:
          type: string
      responses:
        '200':
          description: Success
          x-microcks-refs:
          - name: getSlabZone200Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxSlabZone'
              example:
                pages:
                  used: 1143
                  free: 2928
                slots:
                  8:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
                  16:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
                  32:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
                  64:
                    used: 1
                    free: 63
                    reqs: 1
                    fails: 0
                  128:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
                  256:
                    used: 18078
                    free: 178
                    reqs: 1635736
                    fails: 0
        '404':
          description: 'Slab not found (*SlabNotFound*),

            unknown version (*UnknownVersion*)

            '
          x-microcks-refs:
          - name: getSlabZone404Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
              example:
                error: {}
                request_id: example-request_id
                href: example-href
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Slabs
      summary: NGINX Reset Slab Statistics
      description: Resets the “<literal>reqs</literal>” and “<literal>fails</literal>” metrics for each memory slot.
      operationId: deleteSlabZoneStats
      responses:
        '204':
          description: Success
        '404':
          description: 'Slab not found (*SlabNotFound*),

            unknown version (*UnknownVersion*)

            '
          x-microcks-refs:
          - name: deleteSlabZoneStats404Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
              example:
                error: {}
                request_id: example-request_id
                href: example-href
        '405':
          description: Method disabled (*MethodDisabled*)
          x-microcks-refs:
          - name: deleteSlabZoneStats405Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
              example:
                error: {}
                request_id: example-request_id
                href: example-href
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    NginxSlabZoneMap:
      title: Slab Zones
      description: 'Status zones that use slab allocator.

        '
      type: object
      additionalProperties:
        $ref: '#/components/schemas/NginxSlabZone'
      example:
        http_cache:
          pages:
            used: 2
            free: 2452
          slots:
            8:
              used: 0
              free: 0
              reqs: 0
              fails: 0
            16:
              used: 0
              free: 0
              reqs: 0
              fails: 0
            32:
              used: 1
              free: 126
              reqs: 1
              fails: 0
            64:
              used: 2
              free: 62
              reqs: 2
              fails: 0
            128:
              used: 0
              free: 0
              reqs: 0
              fails: 0
        dns-backends:
          pages:
            used: 1143
            free: 2928
          slots:
            8:
              used: 0
              free: 0
              reqs: 0
              fails: 0
            16:
              used: 0
              free: 0
              reqs: 0
              fails: 0
            32:
              used: 0
              free: 0
              reqs: 0
              fails: 0
            64:
              used: 1
              free: 63
              reqs: 1
              fails: 0
            128:
              used: 0
              free: 0
              reqs: 0
              fails: 0
            256:
              used: 18078
              free: 178
              reqs: 1635736
              fails: 0
    NginxSlabZone:
      title: Shared memory zone with slab allocator
      description: 'Shared memory zone with slab allocator

        '
      type: object
      properties:
        pages:
          type: object
          description: The number of free and used memory pages.
          properties:
            used:
              type: integer
              description: The current number of used memory pages.
              example: 0
            free:
              type: integer
              description: The current number of free memory pages.
              example: 0
          example: {}
        slots:
          type: object
          title: Memory Slots
          description: Status data for memory slots (8, 16, 32, 64, 128, etc.)
          additionalProperties:
            $ref: '#/components/schemas/NginxSlabZoneSlot'
          example: {}
      example:
        pages:
          used: 1143
          free: 2928
        slots:
          8:
            used: 0
            free: 0
            reqs: 0
            fails: 0
          16:
            used: 0
            free: 0
            reqs: 0
            fails: 0
          32:
            used: 0
            free: 0
            reqs: 0
            fails: 0
          64:
            used: 1
            free: 63
            reqs: 1
            fails: 0
          128:
            used: 0
            free: 0
            reqs: 0
            fails: 0
          256:
            used: 18078
            free: 178
            reqs: 1635736
            fails: 0
    NginxError:
      title: Error
      description: 'nginx error object.

        '
      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
    NginxSlabZoneSlot:
      title: Memory Slot
      type: object
      properties:
        used:
          type: integer
          description: The current number of used memory slots.
          example: 0
        free:
          type: integer
          description: The current number of free memory slots.
          example: 0
        reqs:
          type: integer
          description: The total number of attempts to allocate memory of specified size.
          example: 0
        fails:
          type: integer
          description: The number of unsuccessful attempts to allocate memory of specified size.
          example: 0