GET /v1/delivery/purge/options returns the groups valid for the domain
Before purging, ask which purge groups apply to the target domain — the response tells you each group's id, label, and whether it needs a list of media paths.
The request#
curl -H "X-Api-Key: $TENANT_API_KEY" \
"https://api.example.com/v1/delivery/purge/options?domain=www.acme.com"domain accepts a hostname or a domain id (an https:// prefix is stripped automatically). An empty value answers domain is required.; an unknown one Domain not found. The response is { domain: { id, hostname }, options: [...] } where each option has id, label, requiresMediaPaths, imageOnly, and a detail sentence.
The groups#
full-site— Full Site: purges non-image proxy cache; no paths needed.specific-urls— Specific URLs: requires paths; up to 10 exact URLs, or a path-wide variant when no query string is supplied.image-urls— Specific Image URLs: requires paths; image cache entries only.cache-tags— Cache Tags: requires up to 10 exact cache tags.cache-rule:<id>— Rule: <name>: purges non-image entries matching that rule's pattern (one group per configured cache rule).
The same group vocabulary powers the dashboard's purge panel — the Cache → Purge cache panel lists them in its Purge group select (screenshot below), so API integrators and dashboard users share one mental model.
Expected result#
A domain-scoped menu of purge groups, ready to pass as purgeGroupId to the request-creation endpoint (see Create a purge request).