---
title: "Test an address against the redirects"
url: https://docs.corefinity.com/api/reference/site-settings/test-site-redirect
type: endpoint
last_updated: 2026-11-13
feature: redirects
related:
  - https://docs.corefinity.com/guides/sites/site-settings/redirects.md
  - https://docs.corefinity.com/mcp/tools/corestack_redirects_test.md
---
# Test an address against the redirects

Answers which rule matches an address and where it sends the visitor. Send `rules` to test an unsaved table
instead of the saved one. Nothing is saved.

```http
POST /api/corestack/sites/{site}/redirects/test
```

- 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

- `host` (string or null): Test as this domain. It must be one of the site's own.
- `rules` (array of objects or null): An unsaved table to test instead of the saved one.
  - `enabled` (boolean) Defaults to `true`.
  - `from` (string, required): The path to redirect, without a query string. For a `regex` rule, the pattern, at most 256 bytes.
  - `hosts` (array of strings or null): Limit the rule to some of the site's own domains. Null or left out on a new rule means every domain; left out on a saved rule keeps what it has.
  - `id` (integer or null): A saved rule's id, to keep it. Leave it out, or send null, for a new rule.
  - `keep_query` (boolean): Whether the request's query string is carried over to the target. Send `false` when the target has a query string of its own. Defaults to `true`.
  - `note` (string or null)
  - `status` (integer) One of `301`, `302`. Defaults to `301`.
  - `to` (string, required): A path or an `https://` address. A `regex` rule may use `$1` to `$9`. A target with a query string of its own is taken only with `keep_query` sent as `false`, and never on a `prefix` rule, where the rest of the path is added at its end. The limit is 2,000 bytes of the target as it is stored, not 2,000 characters as sent. The host is written in lower case and each character outside ASCII is percent-encoded, so `é` counts as six bytes (`%C3%A9`).
  - `type` (string, required) One of `exact`, `prefix`, `regex`.
- `url` (string, required): A path starting with `/`, or a full `http://` or `https://` address.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/redirects/test \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "/services/web-design/ecommerce?ref=footer"
  }'
```

### PHP

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

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/corestack/sites/1042/redirects/test', [
        'url' => '/services/web-design/ecommerce?ref=footer',
    ]);

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/redirects/test', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: '/services/web-design/ecommerce?ref=footer',
  }),
});

// 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/redirects/test",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "url": "/services/web-design/ecommerce?ref=footer",
    },
)

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

## Responses

### 200 What the table answers for the address.

```json
{
  "chain": [
    {
      "from": "/services/web-design/ecommerce?ref=footer",
      "status": 301,
      "to": "/services/websites/ecommerce?ref=footer"
    }
  ],
  "code": 301,
  "host": "www.harbourandfinch.example.com",
  "matched_rule": {
    "enabled": true,
    "from": "/services/web-design",
    "hosts": null,
    "id": 46,
    "keep_query": true,
    "note": null,
    "position": 6,
    "shadowed_by": null,
    "status": 301,
    "to": "/services/websites",
    "type": "prefix"
  },
  "path": "/services/web-design/ecommerce",
  "query": "ref=footer",
  "target": "/services/websites/ecommerce?ref=footer",
  "tried_before": [
    41,
    44,
    45
  ],
  "type": "prefix",
  "url": "https://www.harbourandfinch.example.com/services/web-design/ecommerce?ref=footer",
  "warnings": []
}
```

### 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), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

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

### 409 The site is deleted and waiting to be purged (`deleted`), or still being created (`provisioning`).

```json
{
  "code": "deleted",
  "message": "This site is deleted and waiting to be purged. Restore it first.",
  "reason": "deleted"
}
```

### 422 A field is missing or wrong, such as a `url` that is neither a path nor an address, or a `host` that is not one of the site's domains.

```json
{
  "code": "invalid",
  "errors": {
    "url": [
      "Enter a path such as /old-page, or a full address on this site"
    ]
  },
  "field": "url",
  "message": "Enter a path such as /old-page, or a full address on this site",
  "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. |
| 409 | `deleted` | The site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored. |
| 409 | `provisioning` | The site is still being created. Try again in a few minutes. |
| 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: [Redirects](https://docs.corefinity.com/guides/sites/site-settings/redirects.md)
- MCP tool: [`corestack_redirects_test`](https://docs.corefinity.com/mcp/tools/corestack_redirects_test.md)
