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
| 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. |
409 | varnish_not_offered | Varnish is available for Magento 2 sites only. Nothing to change here. |
429 | rate_limited | Wait for the seconds in Retry-After. |
503 | temporarily_unavailable | The 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"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/sites/1042/varnish/vcl/policy');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/varnish/vcl/policy', {
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/varnish/vcl/policy",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"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"
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "varnish_not_offered",
"message": "Varnish is available for Magento 2 sites only.",
"reason": "varnish_not_offered"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}{
"code": "temporarily_unavailable",
"message": "The VCL policy cannot be read right now. Please try again in a moment.",
"reason": "temporarily_unavailable"
}Try it
Was this helpful?