Delete image API Reference

DELETE

/tenants/{tenant}/registries/{name}/repositories/{repository}/images/{reference}

const url = 'https://api.kupe.cloud/api/v1/tenants/acme/registries/registry/repositories/team-a%252Fapi/images/sha256%3A4f8c0d0e4b1f2b6e7e0c6a3d6c0f3a9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a';
const options = {method: 'DELETE', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.kupe.cloud/api/v1/tenants/acme/registries/registry/repositories/team-a%252Fapi/images/sha256%3A4f8c0d0e4b1f2b6e7e0c6a3d6c0f3a9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a \
  --header 'Authorization: <Authorization>'

Delete an image by digest, with every tag on it. It cannot be restored; the storage is freed when the registry’s weekly clean-up runs. A tag is refused (400): to remove one tag and keep the image, use DELETE …/tags/{tag}. An image that is one platform of a multi-platform image is refused with 409 (code image_in_use): delete the multi-platform image instead. Admin only.

Authorizations

BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

name

required

string

Registry name: always registry

repository

required

string

Repository name without the registry and tenant, with each / encoded as %2F

reference

required

string

Image digest (sha256: and 64 hex digits)

Responses

204

Image deleted

400

Invalid name or repository, or a tag instead of a digest

object

code

string

error

string

field

string

message

string

severity

string

401

Missing or invalid authentication

object

code

string

error

string

field

string

message

string

severity

string

403

Admin access required

object

code

string

error

string

field

string

message

string

severity

string

404

object

code

string

error

string

field

string

message

string

severity

string

409

Part of a multi-platform image (code image_in_use), protected (code image_protected), the registry is not ready (code registry_not_ready) or is being deleted (code terminating)

object

code

string

error

string

field

string

message

string

severity

string

429

Rate limit exceeded

object

code

string

error

string

field

string

message

string

severity

string

503

The registry is busy or temporarily unavailable; retry

object

code

string

error

string

field

string

message

string

severity

string