corestack_ nginx_ rules_ explain
Explain which nginx rule handles a URL.
When to use it
Show which nginx rule would handle a path on an environment row: the server-level steps, the locations nginx considers (the platform's, Redirects and the custom rules) with file and line, the one that wins, try_files branches and the outcome (a file, PHP, a redirect, refused, blocked by the platform or another answer), with notes for maintenance mode and HTTP auth. A static simulation of the saved rules, or of unsaved server rules passed as content: nothing is requested from the site.
The answer: server_steps (the platform guard that blocks the path, then the custom server-level set, return, deny lines and maintenance mode's 503, in the order nginx runs them), locations (each with source — platform, redirects or custom —, file, line, match — exact, prefix, ^~ or regex —, pattern and nested), winner (an index into locations, or null when a server-level step answers), try_files_branches (both branches, because whether a file exists is not known), outcome (kind: static, php, redirect, denied, returned or blocked, with detail) and notes. Lines in custom-server.inc count the file's two banner lines; the sentences in detail and notes name the line as the editor shows it. A matching regex beats a plain prefix, so a prefix location can be listed as matched without winning.
The platform's own guards run first, before the custom rules and maintenance mode: hidden files and folders (a name starting with a dot, except /.well-known/; Magento 2 allows its media .thumbs images), backup copies of PHP files (.php~, .php.bak, .php.orig, .php.save, .php.swp, .php.old), names ending in ~, PHP source files no PHP location runs (.phtml, .pht, .phps, .php0 to .php9) and .php in any case but lower case. A custom PHP site also blocks the files a deployment keeps beside its code (.env, .log, .sql, .sql.gz, .bak, .orig, .save, .swp, .ini, .lock, .yml, .yaml, .inc, .phar, .dist), Composer's composer.json and auth.json, the vendor/ folder at the top of the site and every node_modules folder. A guarded path answers outcome.kind blocked with outcome.guard (hidden, backup, tilde, php_source or php_case; on custom PHP also deploy_files, composer, vendor or node_modules), a 404 no custom rule can change, and its server step (effect: guard) names the platform file and line. Every runtime version has these guards; an environment still on the Laravel, Magento 2 or WordPress package rules has none, and a note says so when the Control Panel cannot tell.
Corefinity's backup-file rule runs next, still before the custom rules: while it is on for the environment (backup_guard in corestack_nginx_rules_get; corestack_nginx_backup_guard_set switches it), a path ending in .sql or .sql.gz answers outcome.kind blocked with outcome.guard backup_files, and its server step (effect: guard) names flags.inc. Where the rule is on, a path ending in .zip, .tar.gz or .tgz is served as usual and a note says Corefinity does not block it.
Ask for it
Using the Corefinity MCP server, call corestack_nginx_rules_explain with site_id 4211, path /wp-content/uploads/catalogues/2019/spring.pdf. (Explain which nginx rule handles a URL.) Tell me what it returned.Inputs
Unsaved rules, as corestack_nginx_rules_validate takes them: only the server hook decides which location answers. Without content.server the saved server rules are explained.
Fields
One of the row's hosts. Default: its first. Up to 253 characters.
The request path, starting with / (a query string may follow ?), for example /wp-content/uploads/report.pdf. Up to 2,048 characters.
Unsaved path apps and gates (the whole list) instead of the saved ones.
The environment row whose nginx is simulated. At least 1.
Example call
{
"name": "corestack_nginx_rules_explain",
"arguments": {
"site_id": 4211,
"path": "/wp-content/uploads/catalogues/2019/spring.pdf"
}
}If it is refused
| Reason | What to do |
|---|---|
nginx_invalid | The server rules in content (or saved) do not parse; details.diagnostics lists the errors with their file lines. |
too_large | The server rules are over the hook size limit. |
invalid_arguments | The arguments do not match the tool's input schema, or the Control Panel refused a field. Fix the fields named in the answer and call again. |
tenant_mismatch | The object does not exist or the token may not see it. Check the id. |
scope_required | The token lacks a scope this call needs. Open the link in the answer to add it, then call again. |
pin_refused | The grant is limited to chosen clusters, sites or environments, and this call is outside them. Open the link in the answer to widen it. |
rate_limited | Too many calls. Wait for the number of seconds the answer names. |
temporarily_unavailable | The Control Panel could not answer just now. Nothing was started; try again shortly. |
internal_error | Something went wrong on our side. Quote the trace id to support. |
Path apps
Path apps and gates take part in the explanation: the saved ones, or an unsaved list passed as path_apps (the whole list, as corestack_nginx_rules_update takes it). A path app's location is listed with source path_app, the file path-apps.inc and its record id, and wins over the platform's regex locations under its prefix; a gate, and a path app's own address, host and method limits, are server-level steps that name their record and run after maintenance mode. An unlisted PHP file under a php-app's prefix is explained as refused (404). A path under a proxy's prefix is explained as forwarded to its proxy.url, answered by that site and never cached here. A list that is not valid is nginx_invalid with its diagnostics.
Inputs while path apps are on
path_apps(list of path app and gate records, ascorestack_nginx_rules_updatetakes them): Unsaved path apps and gates (the whole list, ascorestack_nginx_rules_updatetakes it), explained instead of the saved ones.
Example
{
"name": "corestack_nginx_rules_explain",
"arguments": {
"site_id": 4211,
"path": "/wp/xmlrpc.php"
}
}