NGINX

NGINX Resolvers API

The Resolvers API from NGINX — 2 operation(s) for resolvers.

GitHub OpenAPI

Operations 3

GET /resolvers/ NGINX Return Status for All Resolver Zones #
GET /resolvers/{resolverZoneName} NGINX Return Statistics of a Resolver Zone #
DELETE /resolvers/{resolverZoneName} NGINX Reset Statistics for a Resolver Zone #

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-resolvers-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-resolvers-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-resolvers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '9.0'
  title: NGINX Plus REST Resolvers 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: Resolvers
paths:
  /resolvers/:
    get:
      tags:
      - Resolvers
      summary: NGINX Return Status for All Resolver Zones
      description: Returns status information for each [resolver zone](https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone).
      operationId: getResolverZones
      responses:
        '200':
          description: Success
          x-microcks-refs:
          - name: getResolverZones200Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxResolverZonesMap'
              example:
                resolver_zone1:
                  requests:
                    name: 25460
                    srv: 130
                    addr: 2580
                  responses:
                    noerror: 26499
                    formerr: 0
                    servfail: 3
                    nxdomain: 0
                    notimp: 0
                    refused: 0
                    timedout: 243
                    unknown: 478
                resolver_zone2:
                  requests:
                    name: 325460
                    srv: 1130
                    addr: 12580
                  responses:
                    noerror: 226499
                    formerr: 0
                    servfail: 283
                    nxdomain: 0
                    notimp: 0
                    refused: 0
                    timedout: 743
                    unknown: 1478
        '404':
          description: Unknown version (*UnknownVersion*)
          x-microcks-refs:
          - name: getResolverZones404Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
              example:
                error: {}
                request_id: example-request_id
                href: example-href
      parameters:
      - in: query
        name: fields
        description: Limits which fields of resolvers statistics will be output.
        x-example: ''
        schema:
          type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /resolvers/{resolverZoneName}:
    parameters:
    - name: resolverZoneName
      in: path
      description: The name of a resolver zone.
      required: true
      x-example: example_resolverZoneName
      schema:
        type: string
    get:
      tags:
      - Resolvers
      summary: NGINX Return Statistics of a Resolver Zone
      description: Returns statistics stored in a particular resolver [zone](https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone).
      operationId: getResolverZone
      parameters:
      - name: fields
        in: query
        description: Limits which fields of the resolver zone will be output (requests, responses, or both).
        x-example: ''
        schema:
          type: string
      responses:
        '200':
          description: Success
          x-microcks-refs:
          - name: getResolverZone200Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxResolverZone'
              example:
                resolver_zone1:
                  requests:
                    name: 25460
                    srv: 130
                    addr: 2580
                  responses:
                    noerror: 26499
                    formerr: 0
                    servfail: 3
                    nxdomain: 0
                    notimp: 0
                    refused: 0
                    timedout: 243
                    unknown: 478
        '404':
          description: 'Resolver zone not found (*ResolverZoneNotFound*),

            unknown version (*UnknownVersion*)

            '
          x-microcks-refs:
          - name: getResolverZone404Example
            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:
      - Resolvers
      summary: NGINX Reset Statistics for a Resolver Zone
      description: Resets statistics in a particular resolver zone.
      operationId: deleteResolverZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: 'Resolver zone not found (*ResolverZoneNotFound*),

            unknown version (*UnknownVersion*)

            '
          x-microcks-refs:
          - name: deleteResolverZoneStat404Example
            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: deleteResolverZoneStat405Example
            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:
    NginxResolverZonesMap:
      title: Resolver Zones
      description: 'Status data for all

        <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zones</a>.

        '
      type: object
      additionalProperties:
        $ref: '#/components/schemas/NginxResolverZone'
      example:
        resolver_zone1:
          requests:
            name: 25460
            srv: 130
            addr: 2580
          responses:
            noerror: 26499
            formerr: 0
            servfail: 3
            nxdomain: 0
            notimp: 0
            refused: 0
            timedout: 243
            unknown: 478
        resolver_zone2:
          requests:
            name: 325460
            srv: 1130
            addr: 12580
          responses:
            noerror: 226499
            formerr: 0
            servfail: 283
            nxdomain: 0
            notimp: 0
            refused: 0
            timedout: 743
            unknown: 1478
    NginxResolverZone:
      title: Resolver Zone
      description: 'Statistics of DNS requests and responses per particular

        <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zone</a>.

        '
      type: object
      properties:
        requests:
          type: object
          readOnly: true
          properties:
            name:
              type: integer
              description: The total number of requests to resolve names to addresses.
              readOnly: true
              example: my_shared_zone
            srv:
              type: integer
              description: The total number of requests to resolve SRV records.
              readOnly: true
              example: 0
            addr:
              type: integer
              description: The total number of requests to resolve addresses to names.
              readOnly: true
              example: 0
          example: 31070465
        responses:
          type: object
          readOnly: true
          properties:
            noerror:
              type: integer
              description: The total number of successful responses.
              readOnly: true
              example: 0
            formerr:
              type: integer
              description: The total number of FORMERR (<literal>Format error</literal>) responses.
              readOnly: true
              example: 0
            servfail:
              type: integer
              description: The total number of SERVFAIL (<literal>Server failure</literal>) responses.
              readOnly: true
              example: 0
            nxdomain:
              type: integer
              description: The total number of NXDOMAIN (<literal>Host not found</literal>) responses.
              readOnly: true
              example: 0
            notimp:
              type: integer
              description: The total number of NOTIMP (<literal>Unimplemented</literal>) responses.
              readOnly: true
              example: 0
            refused:
              type: integer
              description: The total number of REFUSED (<literal>Operation refused</literal>) responses.
              readOnly: true
              example: 0
            timedout:
              type: integer
              description: The total number of timed out requests.
              readOnly: true
              example: 0
            unknown:
              type: integer
              description: The total number of requests completed with an unknown error.
              readOnly: true
              example: 0
          example: 1234567
      example:
        resolver_zone1:
          requests:
            name: 25460
            srv: 130
            addr: 2580
          responses:
            noerror: 26499
            formerr: 0
            servfail: 3
            nxdomain: 0
            notimp: 0
            refused: 0
            timedout: 243
            unknown: 478
    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