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.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Body
Unsaved hooks to explain instead of the saved ones, or the server hook's text on its own.
One of the site's hostnames. Its main one when left out.
A path on the site, such as /media/catalog/product/a.jpg.
An unsaved list of path apps to explain instead of the saved one. Only while path apps are on for your company.
Fields of each item
Some of the site's hostnames. Empty means all of them. Up to 16 items.
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.
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.
A note. Empty when left out. Null is refused. Defaults to ``. Up to 80 characters.
For a PHP app.
Fields
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. At least 1.
The PHP time limit in seconds. Defaults to 300. 30 to 300.
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.
Fields of each item
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.
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.
The request methods admitted. GET, HEAD and POST when left out.
GETHEADPOSTPUTPATCHDELETEOPTIONSFor a PHP app, which needs it.
Fields
Up to 8 folders whose index.php answers the folder, such as wp-admin/.
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.
Up to 4 folders passed to the app's index.php, such as wp-json/, or / for the whole app.
The path, such as /wp/. A PHP app or a gate can also name one file, and a gate / with hosts.
The preset the record started from.
For another site on the path, which needs it.
Fields
Defaults to 5. 1 to 30.
target (the other site's own name), visitor (the name the visitor used) or another host name. Defaults to target.
keep sends the path as it is; strip leaves your path out. Defaults to keep.
keepstripDefaults to 60. 5 to 300.
True sends your visitors' cookies and logins to the other site and lets it set cookies here. Defaults to false.
The other site: https://, a host name and optionally a port and a folder. Up to 255 characters.
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.
Fields
0 to 1000.
1 to 1000.
For a PHP app or static folder: htdocs or shared, optionally with sub-folders.
For a PHP app or static folder.
Fields
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.
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.
php-appstaticproxydenygateReturns
200 The explanation.
Fields of the 200 answer
The server block that takes the request.
Fields
The locations that were considered.
Fields of each item
exact, prefix, ^~ or regex.
Sent when source is path_app, the rule of a path app or gate: its id, such as a1.
Whose rule it is: the platform's, a redirect's or your own.
platformredirectspath_appcustomFields
What answers, in plain words.
For blocked: the protection that answered.
staticphpredirectdeniedreturnedblockedWhat runs before a location is chosen, in order.
The position in locations of the one that answers, starting at 0. Null when none does.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | 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. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
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"
}'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();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);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{
"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
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "too_large",
"diagnostics": [],
"hook": "server",
"max_bytes": 65536,
"message": "A hook file may hold 65536 bytes.",
"reason": "too_large"
}{
"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"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}