Powered by Redocly

Subtenant Remote Registry Operations

Invoke the list-remote-images operation

Fetch the list of available images from a remote registry.

Note: not all registries allow this.

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

Request Body schema:
image
required
string <image-string>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/tenants/{tenant-name}/image-registry/list-remote-images
Request samples 
image: registry.gitlab.com/avassa-public/movie-theaters-demo/kettle-popper-manager:v1.0
Response samples 
images:
  - name: avassa-public/movie-theaters-demo/kettle-popper-manager:v1.0
    digest: sha256:38cd92e53bd34757638e833d179198fc8254b8ed6156e9fc70946bd4eec4ba26
    type: image-index
    images:
      - digest: sha256:5d8dea50be787ce679a676dafc6e63c4af27bc97d8cd455387b73b89b03742fa
        platform: linux/amd64
        image-id: sha256:30f8fc5a7f151873cf9fc3c0b628ef702c69ae08e418e17440d012c088bc05d1
        compressed-size: 34.87 MiB
        labels: {}
      - digest: sha256:419bb49533b1825b2448abe8e310773f22a6158142bf570f17b8e3a07d4f82e4
        platform: linux/arm64
        image-id: sha256:924653a7208e0ff754b0416ef8bbffa229f79ed88bbb8e56fc337f51fb58c6b8
        compressed-size: 34.92 MiB
        labels: {}

Invoke the pull operation

Pull an image from a remote registry.

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

Request Body schema:
One of:
all-platforms
boolean

Must have the value true.

Include all platforms that are available for this image.

image
required
string <image-string>
to
string <image-string>

Optional target repository and tag

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/tenants/{tenant-name}/image-registry/pull
Request samples 
image: registry.gitlab.com/avassa-public/movie-theaters-demo/kettle-popper-manager
all-platforms: true
to: movie-theaters-demo/kettle-popper-manager
Response samples 
name: avassa-public/movie-theaters-demo/kettle-popper-manager:latest
digest: sha256:5d8dea50be787ce679a676dafc6e63c4af27bc97d8cd455387b73b89b03742fa
tag-updated: true

Invoke the verify-credentials operation

Try to connect and authenticate with the remote registry and verify read access to an image (without actually pulling it). Returns 'success' or an error message.

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

Request Body schema:
image
required
string <image-string>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/tenants/{tenant-name}/image-registry/verify-credentials
Request samples 
image: registry.gitlab.com/avassa-public/movie-theaters-demo/curtain-controller
Response samples 
success: true
digest: sha256:565f2b8629c3f5e6b79b78157fdb0c640e5a4fc53a43f728624be7df8831bd3e
➔ Next to Subtenant Remote Registry Settings