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

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

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.
429rate_limitedWait 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"
{
  "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"
    }
  ]
}
Try it
Held in this tab's memory only. Never stored or sent to us.

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

Was this helpful?
Open in ClaudeOpen in ChatGPT