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>
brief
boolean

Must have the value true.

digest-length
string or integer <enumeration | uint8>
Default: "full"
  • enumeration: - full - short
  • uint8
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
digest-length: full
Response samples 
images:
  - name: registry.gitlab.com/avassa-public/movie-theaters-demo/kettle-popper-manager:v1.0
    digest: sha256:dadd899f7fe436b604183cbe0cc69d2144eea14a3050aff59c6a596d09a2cca7
    image-index:
      media-type: application/vnd.oci.image.index.v1+json
      annotations: {}
      manifests:
        - digest: sha256:66d89ad90c22706d7a7d9bb94f094239ce91157793bb0ec7d606ca732118a902
          media-type: application/vnd.oci.image.manifest.v1+json
          platform: linux/amd64
          annotations: {}
        - digest: sha256:e25f813685e4ce58d81dba1db905bc76f6c4da877c0baa094a03766ab650bbf2
          media-type: application/vnd.oci.image.manifest.v1+json
          platform: linux/arm64
          annotations: {}
        - digest: sha256:eab51c73922605a50430720e7b9b6eb0ab4225fd77cda474ccd84b38866cd35d
          media-type: application/vnd.oci.image.manifest.v1+json
          platform: unknown/unknown
          annotations:
            vnd.docker.reference.type: attestation-manifest
            vnd.docker.reference.digest: sha256:66d89ad90c22706d7a7d9bb94f094239ce91157793bb0ec7d606ca732118a902
        - digest: sha256:9cd226818a10503d97068514672e9af0aa91e9c26d3c8c4f494b61ab98c0dab7
          media-type: application/vnd.oci.image.manifest.v1+json
          platform: unknown/unknown
          annotations:
            vnd.docker.reference.type: attestation-manifest
            vnd.docker.reference.digest: sha256:e25f813685e4ce58d81dba1db905bc76f6c4da877c0baa094a03766ab650bbf2

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