NGINX · Schema
Response
The Response interface of the Fetch API (since 0.5.1). Returned by ngx.fetch() as a resolved Promise.
API GatewayCachingCloud-NativeLoad BalancerOpen-SourceReverse ProxyWeb Server
Properties
| Name | Type | Description |
|---|---|---|
| ok | boolean | True if the response status is 200-299. |
| redirected | boolean | True if the response is the result of a redirect. |
| status | integer | HTTP status code of the response. |
| statusText | string | Status message corresponding to the status code. |
| headers | object | |
| bodyUsed | boolean | True if the body has already been read. |
| type | string | Type of the response. |
| url | string | URL of the response. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-schema/njs-response-schema.json",
"title": "Response",
"description": "The Response interface of the Fetch API (since 0.5.1). Returned by ngx.fetch() as a resolved Promise.",
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"readOnly": true,
"description": "True if the response status is 200-299.",
"example": true
},
"redirected": {
"type": "boolean",
"readOnly": true,
"description": "True if the response is the result of a redirect.",
"example": false
},
"status": {
"type": "integer",
"readOnly": true,
"description": "HTTP status code of the response.",
"example": 200
},
"statusText": {
"type": "string",
"readOnly": true,
"description": "Status message corresponding to the status code.",
"example": "OK"
},
"headers": {
"readOnly": true,
"allOf": [
{
"type": "object",
"description": "The Headers interface of the Fetch API (since 0.5.1). Represents HTTP headers and provides methods to manipulate them.",
"properties": null,
"additionalProperties": {
"type": "string"
}
}
]
},
"bodyUsed": {
"type": "boolean",
"readOnly": true,
"description": "True if the body has already been read.",
"example": false
},
"type": {
"type": "string",
"readOnly": true,
"description": "Type of the response.",
"example": "string"
},
"url": {
"type": "string",
"readOnly": true,
"description": "URL of the response.",
"example": "http://upstream.example.com/api"
}
}
}
Work with this as data
Every JSON Schema 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 schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema 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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/njs-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.