Powered by Redocly

Image Repositories

Overview of all tagged images that are stored in this repository.

Note that images without a tag can also be stored in the same repository, use the manifest-list resource to fetch a list of all images stored in this repository.

Retrieve all repositories

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/image-registry/repositories
Response samples 
- name: alpine
  tags:
    - tag: latest
      digest: sha256:bc41182d7ef5ffc53a40b044e725193bc10142a1243f395ee852a8d9730fc2ad
    - tag: "3.14"
      digest: sha256:92d13cc58a46e012300ef49924edc56de5642ada25c9a457dce4a6db59892650

Retrieve a repository

SecurityaccessToken
Request
path Parameters
repository-name
required
string <repository-string>

name of repository

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/image-registry/repositories/{repository-name}
Response samples 
name: alpine
tags:
  - tag: latest
    digest: sha256:bc41182d7ef5ffc53a40b044e725193bc10142a1243f395ee852a8d9730fc2ad
  - tag: "3.14"
    digest: sha256:92d13cc58a46e012300ef49924edc56de5642ada25c9a457dce4a6db59892650

Invoke the delete operation

Delete all images in this repository.

SecurityaccessToken
Request
path Parameters
repository-name
required
string <repository-string>

name of repository

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/image-registry/repositories/{repository-name}/delete

Invoke the create-tag operation

Create a new tag referring to the same digest as this tag refers to.

SecurityaccessToken
Request
path Parameters
repository-name
required
string <repository-string>

name of repository

tag
required
string <tag> ^[a-zA-Z0-9_][a-zA-Z0-9_.-]*$

tag of tag

Request Body schema:
name
required
string <tag> ^[a-zA-Z0-9_][a-zA-Z0-9_.-]*$

The name of the new tag.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/image-registry/repositories/{repository-name}/tags/{tag}/create-tag
Request samples 
name: v2
Response samples 
digest: sha256:ff6bdca1701f3a8a67e328815ff2346b0e4067d32ec36b7992c1fdc001dc8517

Invoke the delete operation

Delete this tag and the image it refers to.

SecurityaccessToken
Request
path Parameters
repository-name
required
string <repository-string>

name of repository

tag
required
string <tag> ^[a-zA-Z0-9_][a-zA-Z0-9_.-]*$

tag of tag

Request Body schema:
tag-only
boolean
Default: false

When 'true' only the tag will be deleted (not the image).

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/image-registry/repositories/{repository-name}/tags/{tag}/delete
Request samples 
tag-only: true
➔ Next to Image Repository