NGINX · JSON Structure

Njs Response Structure

The Response interface of the Fetch API (since 0.5.1). Returned by ngx.fetch() as a resolved Promise.

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

Response 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": "Response",
  "description": "The Response interface of the Fetch API (since 0.5.1). Returned by ngx.fetch() as a resolved Promise.",
  "type": "object",
  "members": {
    "ok": {
      "description": "True if the response status is 200-299.",
      "type": "boolean",
      "readOnly": true,
      "example": true
    },
    "redirected": {
      "description": "True if the response is the result of a redirect.",
      "type": "boolean",
      "readOnly": true,
      "example": false
    },
    "status": {
      "description": "HTTP status code of the response.",
      "type": "int32",
      "readOnly": true,
      "example": 200
    },
    "statusText": {
      "description": "Status message corresponding to the status code.",
      "type": "string",
      "readOnly": true,
      "example": "OK"
    },
    "headers": {
      "allOf": [
        {
          "$ref": "#/definitions/Headers"
        }
      ],
      "readOnly": true
    },
    "bodyUsed": {
      "description": "True if the body has already been read.",
      "type": "boolean",
      "readOnly": true,
      "example": false
    },
    "type": {
      "description": "Type of the response.",
      "type": "string",
      "readOnly": true,
      "example": "string"
    },
    "url": {
      "description": "URL of the response.",
      "type": "string",
      "readOnly": true,
      "example": "http://upstream.example.com/api"
    }
  }
}

Work with this as data

Every JSON Structure 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 json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • 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 JSON Structure
curl "https://apis.io/api/v1/json-structures/njs-response-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?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.

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