hosting

GET /v1/sites/{siteId}/cdn/optimisations

Every edge optimisation available on the site, and whether it is on.

All hosting endpoints

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/cdn/optimisations \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

`risk_levels` and `classes` are derived from the returned rows rather than fixed, so a vendor that introduces a new risk level does not silently drop a whole group of optimisations out of a client that groups by a hardcoded list. `display_name` is generated from the machine name. ⛔ The vendor's own `DisplayName` field is an **untranslated i18n key** (`add_base_tag_title`) and is never carried to a client. Requires `sites.view`.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).

Response

NameTypeRequiredWhat it is
dataSiteCdnOptimisation[]Yes
risk_levelsstring[]YesEvery risk level present in `data`, derived rather than fixed.
classesstring[]YesEvery optimisation class present in `data`, derived rather than fixed.

Errors this endpoint can return

401 · 403 · 404 · 429 · 503