---
title: "Explain which rule answers an address"
url: https://docs.corefinity.com/api/reference/site-settings/test-site-nginx-rules
type: endpoint
last_updated: 2026-11-13
feature: nginx-rules
related:
  - https://docs.corefinity.com/guides/sites/site-settings/web-server-rules.md
  - https://docs.corefinity.com/mcp/tools/corestack_nginx_rules_explain.md
---
# Explain which rule answers an address

Works out which rule answers a path on the site, step by step: the locations that were considered, the one that won and what it answers. Send `content` to explain unsaved hooks instead of the saved ones. Nothing is saved and no request is made to the site.

```http
POST /api/corestack/sites/{site}/nginx-rules/explain
```

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 60 a minute
- Try it in the console: on

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.

## Body

- `content` (object or string or any or null): Unsaved hooks to explain instead of the saved ones, or the server hook's text on its own.
- `host` (string or null): One of the site's hostnames. Its main one when left out.
- `path` (string, required): A path on the site, such as `/media/catalog/product/a.jpg`.
- `path_apps` (array of objects or null): An unsaved list of path apps to explain instead of the saved one. Only while path apps are on for your company.
  - `hosts` (array of strings): Some of the site's hostnames. Empty means all of them.
  - `id` (string): `a1`, `a2` and so on for a PHP app, static folder, other site or closed path; `g1`, `g2` and so on for a gate. Keep it when you change a record. A new record may leave it out: it is given the next free number.
  - `ips` (array of strings): Addresses or networks admitted, up to 64. A gate needs at least one. A network of /8 or wider, an address in a special-purpose range (the documentation ranges among them) and the platform's own ranges are refused.
  - `label` (string): A note. Empty when left out. Null is refused. Defaults to ``.
  - `limits` (object): For a PHP app.
    - `body_size_mb` (integer or null): The largest request body in MB, at most the site's upload size. Null, the default, leaves the site's own limit in force. Defaults to `null`.
    - `timeout` (integer): The PHP time limit in seconds. Defaults to `300`.
  - `links` (array of objects): For a PHP app or static folder on a folder path: up to 4 folders of the path app that are served from the site's shared folder, such as its uploads. Left out of a saved record when there are none.
    - `path` (string, required): A folder of the path app, relative to its path and ending in `/`, such as `wp-content/uploads/`. Two links cannot share a folder or lie inside one another, and PHP never runs under a link.
    - `target` (string, required): A folder below the site's shared folder that holds only public files, such as `shared/wp-content/uploads` on WordPress, with no trailing `/`. Refused: `shared` itself, a hidden folder (a name that starts with `.`), and a folder that is, is inside or contains one where the platform keeps code, logs or secrets, such as `shared/logs` or `shared/vendor`. The list differs per platform; on WordPress `shared/wp-content/uploads` and the folders below it are allowed although the rest of `shared/wp-content` is not.
  - `methods` (array of strings): The request methods admitted. `GET`, `HEAD` and `POST` when left out.
  - `php` (object): For a PHP app, which needs it.
    - `dir_index` (array of strings): Up to 8 folders whose `index.php` answers the folder, such as `wp-admin/`.
    - `entries` (array of strings, required): 1 to 32 PHP files that may run, relative to the path, such as `wp-login.php` or `wp-admin/*.php`. Every other PHP file under the path answers 404.
    - `router` (array of strings): Up to 4 folders passed to the app's `index.php`, such as `wp-json/`, or `/` for the whole app.
  - `prefix` (string, required): The path, such as `/wp/`. A PHP app or a gate can also name one file, and a gate `/` with `hosts`.
  - `preset` (string or null): The preset the record started from.
  - `proxy` (object): For another site on the path, which needs it.
    - `connect_timeout` (integer) Defaults to `5`.
    - `host_header` (string): `target` (the other site's own name), `visitor` (the name the visitor used) or another host name. Defaults to `target`.
    - `path` (string): `keep` sends the path as it is; `strip` leaves your path out. One of `keep`, `strip`. Defaults to `keep`.
    - `read_timeout` (integer) Defaults to `60`.
    - `share_cookies` (boolean): True sends your visitors' cookies and logins to the other site and lets it set cookies here. Defaults to `false`.
    - `url` (string, required): The other site: `https://`, a host name and optionally a port and a folder.
  - `rate` (object or null): A rate limit per visitor, for a PHP app, a static folder or another site. Send both fields, or leave `rate` out (or send null) for no limit. Left out of a saved record that has none.
    - `burst` (integer, required)
    - `per_second` (integer, required)
  - `root` (string): For a PHP app or static folder: `htdocs` or `shared`, optionally with sub-folders.
  - `static` (object): For a PHP app or static folder.
    - `types` (array of strings): Lower-case file extensions served from disk, up to 32. The policy's default list when left out. A static folder serves at least one.
  - `type` (string, required): A PHP app, a static folder, another site shown on the path (`proxy`), a closed path (`deny`) or a gate that admits only listed addresses. One of `php-app`, `static`, `proxy`, `deny`, `gate`.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules/explain \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "host": "harbourandfinch.example.com",
    "path": "/older"
  }'
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules/explain', [
        'host' => 'harbourandfinch.example.com',
        'path' => '/older',
    ]);

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules/explain', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    host: 'harbourandfinch.example.com',
    path: '/older',
  }),
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.post(
    "https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules/explain",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "host": "harbourandfinch.example.com",
        "path": "/older",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The explanation.

```json
{
  "block": {
    "file": "nginx-site.conf",
    "line": 1,
    "server_name": "harbourandfinch.example.com"
  },
  "locations": [
    {
      "file": "custom-server.inc",
      "hook": "server",
      "line": 3,
      "match": "exact",
      "nested": false,
      "pattern": "/private-report.pdf",
      "source": "custom"
    }
  ],
  "notes": [],
  "outcome": {
    "detail": "404 — return 404 in your Server rules, line 2",
    "kind": "returned"
  },
  "server_steps": [],
  "try_files_branches": [],
  "winner": 0
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), or your company requires two-factor authentication and you have not set it up. For routes outside Managed Clusters.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 413 A hook sent in `content` is over its size limit (`too_large`). `hook` names it and `max_bytes` is the limit.

```json
{
  "code": "too_large",
  "diagnostics": [],
  "hook": "server",
  "max_bytes": 65536,
  "message": "A hook file may hold 65536 bytes.",
  "reason": "too_large"
}
```

### 422 A field is missing or wrong (`invalid`: a path that is not one, a host the site does not serve), or the server hook does not parse (`nginx_invalid`, with `diagnostics`).

```json
{
  "code": "invalid",
  "errors": {
    "path": [
      "Enter a path such as /wp-content/uploads/report.pdf."
    ]
  },
  "field": "path",
  "message": "Enter a path such as /wp-content/uploads/report.pdf.",
  "reason": "invalid"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 413 | `too_large` | The upload is larger than the limit for one file. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Web server rules](https://docs.corefinity.com/guides/sites/site-settings/web-server-rules.md)
- MCP tool: [`corestack_nginx_rules_explain`](https://docs.corefinity.com/mcp/tools/corestack_nginx_rules_explain.md)
