Skip to navigation
API ReferenceCDN

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_idstringRequired>=1 character
CDN distribution ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Request

This endpoint expects an object.
modeenumRequired
Allowed values:
pathslist of stringsOptional
hostnameslist of stringsOptional
tagslist of stringsOptional
prefixeslist of stringsOptional

Response

Cache purge completed.
successboolean
modeenum
Allowed values:
purgedlist of strings or nullOptional
messagestring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error