Get an Nginx test run
Answers a test run's state. Read it again until status is no longer queued or running.
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.
The id of a test run, from a check's test.id. At least 1.
Returns
200 The test run.
Fields of the 200 answer
Fields of each item
A stable code for the problem, such as root_outside_webroot.
For a path app, the field, such as php.entries.1.
The part of the rules it is in, such as server.
For a path app, the id of the record. hook is then path_apps.
error refuses a save; anything else is a warning.
What found it, such as policy.
Format: date-time.
At least 1.
What the site's Nginx said.
Format: date-time.
passed or failed is the test's result. unavailable, timed_out and error mean the test could not be run; a save then relies on the checks after it.
queuedrunningpassedfailedunavailabletimed_outerrorIf 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. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules/tests/1 \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules/tests/1');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules/tests/1', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// 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.get(
"https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules/tests/1",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"diagnostics": [],
"duration_ms": 4000,
"finished_at": "2026-11-06T09:16:44Z",
"id": 9,
"output": "nginx: configuration file test is successful",
"reason": null,
"started_at": "2026-11-06T09:16:40Z",
"status": "passed"
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}