CorefinityCorefinityDocs
Open the Control PanelControl Panel
Varnish · 12 of 19

Get the VCL policy

Answers every rule a snippet must follow: where each snippet runs, what it may read and set, what is refused and the limits. Each refusal's code, such as VN-POL-09, is the code of a diagnostic.

GET/api/corestack/sites/{site}/varnish/vcl/policy

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 policy, shortened here.

Fields of the 200 answer
codesany

What each rule code means.

hook_orderarray of strings
hooksobjectRequired

For each snippet: where it runs, what it may set and return, and what is kept for the platform.

limitsobject
Fields
codesobjectRequired

The rule each limit is refused under.

per_hook_bytesintegerRequired
per_hook_statementsintegerRequired
total_bytesintegerRequired
namestring
policy_versionintegerRequired
refused_hooksobject

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.
409varnish_not_offeredVarnish is available for Magento 2 sites only. Nothing to change here.
429rate_limitedWait for the seconds in Retry-After.
503temporarily_unavailableThe Control Panel could not answer just now. Nothing was started; try again shortly.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/corestack/sites/1042/varnish/vcl/policy \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "hook_order": [
    "recv",
    "backend_response",
    "deliver"
  ],
  "hooks": {
    "deliver": {
      "header_root": "resp",
      "key": "varnish-deliver.vcl",
      "placement": "vcl_deliver, before the platform's header hygiene",
      "refused_references": [],
      "reserved_headers": [
        "Set-Cookie"
      ],
      "returns": [],
      "routing_headers": [],
      "secret_headers_readable": false,
      "stub": "# Your vcl_deliver snippet. Empty means the platform VCL only.\n",
      "sub": "vcl_deliver",
      "writable": []
    }
  },
  "name": "CoreStack Magento 2 customer VCL hooks",
  "policy_version": 2,
  "refused_hooks": {
    "hash": "VN-POL-05",
    "pipe": "VN-POL-07"
  },
  "refused_writes": {
    "req.method": "VN-POL-02",
    "req.url": "VN-POL-09"
  }
}
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