Skip to main content
DELETE
Erase an image

Authorizations

Authorization
string
header
required

An organization API key. Keys carry a role (read_write or read_only) and may be restricted to a namespace prefix such as acme/*, or to one namespace such as acme/prod/tenant_1. A prefix matches on a / boundary: acme/prod/tenant_1* covers acme/prod/tenant_1 and everything under acme/prod/tenant_1/, never acme/prod/tenant_12.

Headers

Idempotency-Key
string

One key per logical request, reused only on its retries. A key belongs to one request: within your organization, the same method, path, query and body. For 24 hours after a successful response, a request with the key and the same body gets that response back verbatim, with Idempotent-Replayed: true, and runs nothing. Only a successful response is kept, so the retry of a request that failed runs again. While the first request runs or its response is kept, the key with a different request is idempotency_key_reused (422). A request sent while one with its key is still running is rate_limited with Retry-After: 1, without running: retry it to get the first one's response. In the rare case the key can't be checked, the request runs as if it had none.

Required string length: 1 - 255

Path Parameters

ns
string
required

The namespace name, with any / sent as %2F. Up to 256 bytes. / separates levels of the hierarchy, as in acme/prod/tenant_123. Never exactly . or .., which a URL path can't carry.

Required string length: 1 - 256
Pattern: ^(?!\.\.?$)[A-Za-z0-9._:/-]+$
digest
string
required

The image's digest, as its reference's digest holds it. The colon may be sent as is or as %3A. An image's digest, sha256: and 64 lowercase hex digits. Two images with the same digest are the same bytes.

Pattern: ^sha256:[0-9a-f]{64}$

Response

The image is erased.

An erased image.

digest
string
required

An image's digest, sha256: and 64 lowercase hex digits. Two images with the same digest are the same bytes.

Pattern: ^sha256:[0-9a-f]{64}$
erased_at
string<date-time>
required

When it was first erased; from then on nothing serves it.