Purge CDN cache
Purges matching cache content synchronously for a distribution in the
selected workspace. For a normal single-page application deployment,
use mode: url with paths: ["/index.html"]. Do not purge
fingerprinted assets such as /assets/app.a91c3.js; use paths: ["/*"] only for an emergency full-cache invalidation.
Authentication
AuthorizationBearer
IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.
Path parameters
distribution_id
CDN distribution ID.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Request
This endpoint expects an object.
mode
url: purge the paths inpaths.hostname: purge everything for the hostnames inhostnames.tag: purge content tagged withtags.prefix: purge paths starting withprefixes.all: purge the whole distribution.
Allowed values:
paths
Paths to purge, for url mode.
hostnames
Hostnames to purge, for hostname mode.
prefixes
Path prefixes to purge, for prefix mode.
Response
Cache purge completed.
success
True when the purge was accepted.
mode
Purge mode that was applied.
urlhostnametagprefixall
Allowed values:
purged
Items that were purged, when the mode lists them.
message
Human-readable result.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
423
Locked Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error
