CorefinityCorefinityDocs
Open the Control PanelControl Panel
Web server rules · 19 of 19

Check Nginx rules without saving

Checks the hooks sent in content against the policy; a hook left out is the saved one. When there are no errors the rules are also tested with the site's own Nginx, unless sandbox is false: test names the run, and reading it answers its result. Nothing is saved.

POST/api/corestack/sites/{site}/nginx-rules/validate

Path parameters

siteintegerRequired

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

contentobject

The text of each hook sent. server goes inside the site's server block (locations, return, rewrite), headers sets response headers for every page, php holds settings for PHP requests and http sits at the http level, for example a map.

Fields
headersstring or null
httpstring or null
phpstring or null
serverstring or null
path_appsarray of objects or null

A list of path apps to check instead of the saved one; it may be sent without content. Only while path apps are on for your company.

Fields of each item
hostsarray of strings

Some of the site's hostnames. Empty means all of them. Up to 16 items.

idstring

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.

ipsarray 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.

labelstring

A note. Empty when left out. Null is refused. Defaults to ``. Up to 80 characters.

limitsobject

For a PHP app.

Fields
body_size_mbinteger 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. At least 1.

timeoutinteger

The PHP time limit in seconds. Defaults to 300. 30 to 300.

linksarray 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.

Fields of each item
pathstringRequired

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.

targetstringRequired

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.

methodsarray of strings

The request methods admitted. GET, HEAD and POST when left out.

GETHEADPOSTPUTPATCHDELETEOPTIONS
phpobject

For a PHP app, which needs it.

Fields
dir_indexarray of strings

Up to 8 folders whose index.php answers the folder, such as wp-admin/.

entriesarray of stringsRequired

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.

routerarray of strings

Up to 4 folders passed to the app's index.php, such as wp-json/, or / for the whole app.

prefixstringRequired

The path, such as /wp/. A PHP app or a gate can also name one file, and a gate / with hosts.

presetstring or null

The preset the record started from.

proxyobject

For another site on the path, which needs it.

Fields
connect_timeoutinteger

Defaults to 5. 1 to 30.

host_headerstring

target (the other site's own name), visitor (the name the visitor used) or another host name. Defaults to target.

pathstring

keep sends the path as it is; strip leaves your path out. Defaults to keep.

keepstrip
read_timeoutinteger

Defaults to 60. 5 to 300.

share_cookiesboolean

True sends your visitors' cookies and logins to the other site and lets it set cookies here. Defaults to false.

urlstringRequired

The other site: https://, a host name and optionally a port and a folder. Up to 255 characters.

rateobject 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.

Fields
burstintegerRequired

0 to 1000.

per_secondintegerRequired

1 to 1000.

rootstring

For a PHP app or static folder: htdocs or shared, optionally with sub-folders.

staticobject

For a PHP app or static folder.

Fields
typesarray 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.

typestringRequired

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-appstaticproxydenygate
renderboolean

True adds path_apps_rendered to the answer. Only while path apps are on for your company. Defaults to false.

sandboxboolean

False checks against the policy only and skips the test on the site's own Nginx. Defaults to true.

Returns

200 What the check found. An empty diagnostics means the rules pass.

Fields of the 200 answer
diagnosticsarray of objectsRequired
Fields of each item
codestringRequired

A stable code for the problem, such as root_outside_webroot.

columninteger or null
fieldstring or null

For a path app, the field, such as php.entries.1.

hookstring or null

The part of the rules it is in, such as server.

lineinteger or null
messagestringRequired
recordstring or null

For a path app, the id of the record. hook is then path_apps.

severitystringRequired

error refuses a save; anything else is a warning.

sourcestring

What found it, such as policy.

path_apps_renderedobject or any or null

With render: true: the Nginx text written for the path apps. Null when there are none or they have errors.

policy_versionintegerRequired
testobject or any or nullRequired

The test run that was started. Null when the test was skipped or the policy found errors.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
409managed_elsewhereThis site is read-only here. Change it in the control panel that manages it.
413too_largeThe upload is larger than the limit for one file.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.
500noneRead the message; it says what happened.

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/validate \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "content": {
      "server": "location = /private-report.pdf {\n    return 404;\n}\n"
    }
  }'
{
  "diagnostics": [],
  "policy_version": 6,
  "test": {
    "id": 9,
    "status": "queued"
  }
}
Try it
Held in this tab's memory only. Never stored or sent to us.

This sends a real POST request and changes your account.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT