Skip to main content

Endpoint

Auth: API Key required

Path parameters

string
required
Path to the file relative to the storage root.photo.jpg · photos/portrait.jpg

What gets cleared

  • Local cache, transformation variants stored on disk
  • Cloud cache, transformation variants stored in S3-compatible storage (if configured)
  • In-memory cache, cached metadata entries for the file
The original file is not touched.

Response

boolean
true only when nothing failed. It is computed as errors.length === 0, so a single non-fatal cleanup error makes it false even though the variants that could be removed were removed. Read details.errors to see what actually happened.
string
Human-readable result summary.
object
Status codes: 200 success (or partial) · 400 path missing · 500 error

Example

Clear the entire cache

Auth: API key required. A dashboard session cookie also works. Removes every cached transformation variant on the instance, local and cloud, for every file. Takes no parameters and no body.
This purges the whole cache, not one file’s variants. Every transformation is regenerated on its next request, so the first hit on each URL pays full processing cost again. On an instance serving many variants that is a significant, self-inflicted load spike. Reach for DELETE /invalidate/{path} unless you genuinely mean all of it.
Status codes: 200 success · 500 a cache backend failed

Delete File

Permanently remove a file and all its cached variants.

Transform

Apply transformations, results are cached automatically.