Replace a site's Nginx rules
Saves the hooks sent in content at the version you read: a hook left out stays as it is, and "" or null clears it. The change is checked, tested, applied and verified against the site's health check and verify paths, and one that fails is put back automatically: follow the operation in the answer. verify_paths may be sent without content.
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
When the change applies, if it needs a one-time update of the site's runtime first. Most changes apply at once whatever is sent. When a change that needs a maintenance window is applied. now applies it at once. tonight queues it for the site's next window. window means the same as tonight. An endpoint that takes window only while maintenance windows are on for your company says so, and refuses it 422 on apply otherwise. Defaults to now.
nowtonightwindowFields
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
Why, shown in the history. Up to 200 characters.
The whole list of path apps and gates: [] removes every one, and leaving it out or sending null keeps the saved list. It may be sent without content. A list whose labels alone changed answers a revision with operation: null. Refused invalid while path apps are not 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-appstaticproxydenygateA passed test run of the same content, from a check, so it is not run again. At least 1.
Replaces the list of paths checked after every change. Sent on its own, only this list is saved. Up to 5 items.
Fields of each item
The answer expected: an exact status such as 403, a class such as 2xx, or <500. Defaults to <500.
A path on the site, starting with /.
The version from the last read. At least 0.
Returns
200 Nothing was started: the content is what the site already has (operation and revision are null), or only the verify paths were saved (version and verify_paths).
201 The change was saved. Follow operation; revision is the new revision. A change that waits for a window answers queued: true with nothing started.
Fields of the 200 answer
Fields of the 201 answer
The id of the queued change.
The change to follow. Null when nothing was started.
On a copy that carried path apps: the records that were not carried (path_app_not_carried).
Present when the change waits for a window.
The new revision. Null when there is none.
The window a queued change waits for. Present only while maintenance windows are on for your company.
The date of the window a queued change waits for.
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. |
409 | busy | Another operation is running on the site. Wait for it to finish. |
409 | conflict | The action conflicts with the object's present state. Read the message. |
409 | managed_elsewhere | This site is read-only here. Change it in the control panel that manages it. |
409 | restore_running | A restore is running on the site. Wait for it to finish, then try again. |
409 | stale | What you read has changed since you read it. Read it again, then send the change with its new version or quote. |
413 | too_large | The upload is larger than the limit for one file. |
422 | feature_off | This feature is not on for your organisation yet. |
422 | invalid | Fix the field named in field; errors says why. |
422 | nginx_invalid | These nginx rules cannot be saved: fix the errors shown. |
422 | nginx_rules_locked | Corefinity has locked this environment's nginx rules. Contact support to change them. |
429 | rate_limited | Wait for the seconds in Retry-After. |
500 | none | Read the message; it says what happened. |
502 | none | Read the message; it says what happened. |
503 | upstream_unavailable | A service the action depends on did not answer. Try again later. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X PUT https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"note": "WordPress admin under /wp/",
"path_apps": [
{
"label": "Blog admin",
"php": {
"dir_index": [
"wp-admin/"
],
"entries": [
"wp-admin/*.php",
"wp-login.php"
],
"router": [
"wp-json/"
]
},
"prefix": "/wp/",
"preset": "wordpress-admin",
"root": "htdocs",
"type": "php-app"
}
],
"version": 0
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->put('https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules', [
'note' => 'WordPress admin under /wp/',
'path_apps' => [
[
'label' => 'Blog admin',
'php' => [
'dir_index' => [
'wp-admin/',
],
'entries' => [
'wp-admin/*.php',
'wp-login.php',
],
'router' => [
'wp-json/',
],
],
'prefix' => '/wp/',
'preset' => 'wordpress-admin',
'root' => 'htdocs',
'type' => 'php-app',
],
],
'version' => 0,
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
note: 'WordPress admin under /wp/',
path_apps: [
{
label: 'Blog admin',
php: {
dir_index: [
'wp-admin/',
],
entries: [
'wp-admin/*.php',
'wp-login.php',
],
router: [
'wp-json/',
],
},
prefix: '/wp/',
preset: 'wordpress-admin',
root: 'htdocs',
type: 'php-app',
},
],
version: 0,
}),
});
// 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.put(
"https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"note": "WordPress admin under /wp/",
"path_apps": [
{
"label": "Blog admin",
"php": {
"dir_index": [
"wp-admin/",
],
"entries": [
"wp-admin/*.php",
"wp-login.php",
],
"router": [
"wp-json/",
],
},
"prefix": "/wp/",
"preset": "wordpress-admin",
"root": "htdocs",
"type": "php-app",
},
],
"version": 0,
},
)
data = res.json() if res.content else None{
"operation": null,
"revision": null
}{
"item_id": 77,
"operation": null,
"queued": true,
"revision": null,
"window_date": "2026-11-07"
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "busy",
"message": "Another change to this site is in progress. Wait for it to finish.",
"reason": "busy"
}{
"code": "too_large",
"hook": "server",
"max_bytes": 65536,
"message": "The server hook is larger than 64 KB.",
"reason": "too_large"
}{
"code": "feature_off",
"message": "Queuing changes for the maintenance window is switched off at the moment",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many attempts on this environment. Try again shortly.",
"reason": "rate_limited",
"retry_after_seconds": 60
}{
"message": "Server Error"
}{
"message": "The change could not be saved. Contact support."
}{
"code": "upstream_unavailable",
"message": "This environment's configuration repository can't be read right now. Try again in a few minutes.",
"reason": "upstream_unavailable"
}Try it is off for this endpointIt overwrites data that cannot be brought back. Copy the request and run it yourself when you are sure.