List ready-made Nginx rules
Lists ready-made rules for the site's platform, each with the hook it belongs in and the values to fill in.
GET/ api/ corestack/ sites/ {site}/ nginx-rules/ snippets
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.
Returns
200 The snippets. The list is shortened here.
Fields of the 200 answer
snippetsarray of objectsRequired
Fields of each item
availablebooleanRequired
Whether the site can use the snippet now.
categorystringRequired
descriptionstringRequired
idstringRequired
needsarray
What the site lacks while the snippet is not available.
partsarray of objectsRequired
The text to insert, with the hook each part belongs in.
Fields of each item
contentstringRequired
A value to fill in is written {{name}}.
hookstringRequired
placementstring
placeholdersarray of objectsRequired
The values to fill in.
Fields of each item
defaultany
kindstring
labelstringRequired
namestringRequired
validatestring or null
A regular expression the value must match.
platformsarray of stringsRequired
requiresarray
titlestringRequired
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. |
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/snippets \
-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/snippets');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/nginx-rules/snippets', {
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/snippets",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"snippets": [
{
"available": true,
"category": "security",
"description": "Answers 403 for every path that starts with one of the listed names.",
"id": "block-paths",
"needs": [],
"parts": [
{
"content": "location ~ ^/(?:{{paths}})(?:/|$) {\n return 403;\n}\n",
"hook": "server",
"placement": "cursor"
}
],
"placeholders": [
{
"default": "private|internal",
"kind": "regex",
"label": "Paths (separated by |, no leading /)",
"name": "paths",
"validate": "^[A-Za-z0-9._\\-|/\\\\]+$"
}
],
"platforms": [
"wordpress",
"magento2",
"laravel",
"php"
],
"requires": [],
"title": "Block paths"
}
]
}{
"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
}Try it
Was this helpful?