---
title: "Get a site's Nginx rules"
url: https://docs.corefinity.com/api/reference/site-settings/get-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_get.md
---
# Get a site's Nginx rules

Answers the four hooks with their text, the `version` every change sends back, whether the rules are live, the verify paths, the limits and, when there is one, a change made outside the Control Panel (`drift`).

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

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 120 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.

## Query parameters

- `include` (string): Send `rendered` to add `path_apps.rendered`, the Nginx text written for the path apps.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

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

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// 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.get(
    "https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The site's Nginx rules.

```json
{
  "adopted": false,
  "adoption": {
    "adopt_now_refusal": null,
    "adopted": false,
    "can_adopt_now": false,
    "can_adopt_tonight": false,
    "in_progress": false,
    "planned_for": null,
    "queued_for": null,
    "revision": null
  },
  "corefinity_rules": null,
  "drift": null,
  "hooks": {
    "headers": {
      "available": false,
      "available_after": {
        "date": null,
        "state": "not_scheduled"
      },
      "content": null
    },
    "http": {
      "available": false,
      "available_after": {
        "date": null,
        "state": "not_scheduled"
      },
      "content": null
    },
    "php": {
      "available": false,
      "available_after": {
        "date": null,
        "state": "not_scheduled"
      },
      "content": null
    },
    "server": {
      "available": true,
      "content": "location = /older {\n    return 410;\n}\n"
    }
  },
  "limits": {
    "max_bytes": 65536,
    "max_lines": 2000,
    "max_locations": 200,
    "used": {
      "headers": null,
      "http": null,
      "php": null,
      "server": {
        "bytes": 161,
        "lines": 3,
        "locations": 1
      }
    },
    "warn_lines": 1500
  },
  "locked": null,
  "platform": "wordpress",
  "policy_version": 6,
  "revision": {
    "author": {
      "client": null,
      "kind": "user",
      "name": "Eleanor Finch"
    },
    "created_at": "2026-11-02T15:41:09Z",
    "errors_since": null,
    "hooks_changed": [
      "server"
    ],
    "id": 317,
    "note": null,
    "number": 2,
    "origin": "editor",
    "status": "applied",
    "status_reason": null
  },
  "site_id": 1042,
  "status": {
    "applied_revision_id": 317,
    "error": null,
    "operation_id": null,
    "pending_reason": null,
    "revert": null,
    "revision_id": 317,
    "state": "live"
  },
  "verify_paths": [
    {
      "expect": "2xx",
      "path": "/checkout"
    }
  ],
  "version": 2
}
```

### 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"
}
```

### 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. |
| 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_get`](https://docs.corefinity.com/mcp/tools/corestack_nginx_rules_get.md)
