Container virtual registry API

Tier: Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed
Status: Beta

The availability of these endpoints is controlled by a feature flag. For more information, see the history.

Use this API to:

Create and manage virtual registries for the container registry.
Configure upstream container registries.
Manage cached container images and manifests.

For information about pulling container images through a virtual registry, see Container virtual registry.

Cloud provider registries are not supported, but issue 20919 proposes to change this behavior.

Manage virtual registries

Use the following endpoints to create and manage virtual registries for the container registry.

List all virtual registries

Lists all container virtual registries for a group.

GET /groups/:id/-/virtual_registries/container/registries

Supported attributes:

Attribute	Type	Required	Description
`id`	string or integer	Yes	The group ID or full-group path. Must be a top-level group.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/container/registries"

Example response:

[
  {
    "id": 1,
    "group_id": 5,
    "name": "my-container-virtual-registry",
    "description": "My container virtual registry",
    "created_at": "2024-05-30T12:28:27.855Z",
    "updated_at": "2024-05-30T12:28:27.855Z"
  }
]

Create a virtual registry

Creates a container virtual registry for a group.

POST /groups/:id/-/virtual_registries/container/registries

Attribute	Type	Required	Description
`id`	string or integer	Yes	The group ID or full-group path. Must be a top-level group.
`name`	string	Yes	The name of the virtual registry.
`description`	string	No	The description of the virtual registry.

You can create a maximum of 5 virtual registries per group.

Example request:

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --data '{"name": "my-container-virtual-registry", "description": "My container virtual registry"}' \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/container/registries"

Example response:

{
  "id": 1,
  "group_id": 5,
  "name": "my-container-virtual-registry",
  "description": "My container virtual registry",
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z"
}

Retrieve a virtual registry

Retrieves a specified container virtual registry.

GET /virtual_registries/container/registries/:id

Parameters:

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the container virtual registry.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/registries/1"

Example response:

{
  "id": 1,
  "group_id": 5,
  "name": "my-container-virtual-registry",
  "description": "My container virtual registry",
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z",
  "registry_upstreams": [
    {
      "id": 2,
      "position": 1,
      "upstream_id": 2
    }
  ]
}

Update a virtual registry

Updates a specified container virtual registry.

PATCH /virtual_registries/container/registries/:id

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the container virtual registry.
`description`	string	No	The description of the virtual registry.
`name`	string	No	The name of the virtual registry.

You must provide at least one of the optional parameters (name or description) in your request.

Example request:

curl --request PATCH \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"name": "my-container-virtual-registry", "description": "My container virtual registry"}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/registries/1"

If successful, returns a 200 OK status code.

Delete a virtual registry

When you delete a virtual registry, you also delete all associated upstream registries that are not shared with other virtual registries, along with their cached container images and manifests.

Deletes a specified container virtual registry.

DELETE /virtual_registries/container/registries/:id

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the container virtual registry.

Example request:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/registries/1"

If successful, returns a 204 No Content status code.

Delete cache entries for a virtual registry

Schedules all cache entries for deletion in all exclusive upstream registries for a container virtual registry. Cache entries are not scheduled for deletion for upstream registries that are associated with other virtual registries.

DELETE /virtual_registries/container/registries/:id/cache

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the container virtual registry.

Example request:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/registries/1/cache"

If successful, returns a 204 No Content status code.

Manage upstream registries

Use the following endpoints to configure and manage upstream container registries.

List all upstream registries for a top-level group

Lists all upstream container registries for a top-level group.

GET /groups/:id/-/virtual_registries/container/upstreams

Supported attributes:

Attribute	Type	Required	Description
`id`	string or integer	Yes	The group ID or full-group path. Must be a top-level group.
`page`	integer	No	The page number. Defaults to 1.
`per_page`	integer	No	The number of items per page. Defaults to 20.
`upstream_name`	string	No	The name of the upstream registry for fuzzy search filtering by name.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/container/upstreams"

Example response:

[
  {
    "id": 1,
    "group_id": 5,
    "url": "https://registry-1.docker.io",
    "name": "Docker Hub",
    "description": "Docker Hub registry",
    "cache_validity_hours": 24,
    "username": "user",
    "created_at": "2024-05-30T12:28:27.855Z",
    "updated_at": "2024-05-30T12:28:27.855Z"
  }
]

Test connection before creating an upstream registry

Tests the connection to a container upstream registry that has not been added to the virtual registry yet. This endpoint validates connectivity and credentials before creating the upstream registry.

POST /groups/:id/-/virtual_registries/container/upstreams/test

Supported attributes:

Attribute	Type	Required	Description
`id`	string or integer	Yes	The group ID or full-group path. Must be a top-level group.
`url`	string	Yes	The URL of the upstream registry.
`password`	string	No	The password of the upstream registry.
`username`	string	No	The username of the upstream registry.

You must include both the username and password in the request, or neither. If not set, a public (anonymous) request is used to access the upstream.

Test workflow

The test endpoint sends a HEAD request to the provided upstream URL using a test path to validate connectivity and authentication. The response received from the HEAD request is interpreted as follows:

Upstream Response	Description	Result
2XX	Success. Upstream accessible	`{ "success": true }`
404	Success. Upstream accessible, but test artifact not found	`{ "success": true }`
401	Authentication failed	`{ "success": false, "result": "Error: 401 - Unauthorized" }`
403	Access forbidden	`{ "success": false, "result": "Error: 403 - Forbidden" }`
5XX	Upstream server error	`{ "success": false, "result": "Error: 5XX - Server Error" }`
Network errors	Connection/timeout issues	`{ "success": false, "result": "Error: Connection timeout" }`

Example request:

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/container/upstreams/test"
     --data '{"url": "https://registry-1.docker.io", "username": "<your_username>", "password": "<your_password>"}' \

Example response:

{
  "success": true
}

Both 2XX (found) and 404 Not Found HTTP status codes from the upstream registry are considered successful responses, as they indicate the upstream is reachable and properly configured.

List all upstream registries for a virtual registry

Lists all upstream registries for a container virtual registry.

GET /virtual_registries/container/registries/:id/upstreams

Supported attributes:

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the container virtual registry.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/registries/1/upstreams"

Example response:

[
  {
    "id": 1,
    "group_id": 5,
    "url": "https://registry-1.docker.io",
    "name": "Docker Hub",
    "description": "Docker Hub registry",
    "cache_validity_hours": 24,
    "username": "user",
    "created_at": "2024-05-30T12:28:27.855Z",
    "updated_at": "2024-05-30T12:28:27.855Z",
    "registry_upstream": {
      "id": 1,
      "registry_id": 1,
      "position": 1
    }
  }
]

Create an upstream registry

Creates an upstream container registry for a specified container virtual registry.

POST /virtual_registries/container/registries/:id/upstreams

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the container virtual registry.
`url`	string	Yes	The URL of the upstream container registry.
`name`	string	Yes	The name of the upstream registry.
`cache_validity_hours`	integer	No	The cache validity period for container images. Defaults to 24 hours.
`description`	string	No	The description of the upstream registry.
`password`	string	No	The password of the upstream registry.
`username`	string	No	The username of the upstream registry.

You must include both the username and password in the request, or not at all. If not set, a public (anonymous) request is used to access the upstream.

You cannot add two upstreams with the same URL and credentials (username and password) to the same top-level group. Instead, you can either:

Set different credentials for each upstream with the same URL.
Associate an upstream with multiple virtual registries.

You can add a maximum of 5 upstream registries to each virtual registry.

Example request:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"url": "https://registry-1.docker.io", "name": "Docker Hub", "description": "Docker Hub registry", "username": "<your_username>", "password": "<your_password>", "cache_validity_hours": 48}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/registries/1/upstreams"

Example response:

{
  "id": 1,
  "group_id": 5,
  "url": "https://registry-1.docker.io",
  "name": "Docker Hub",
  "description": "Docker Hub registry",
  "cache_validity_hours": 48,
  "username": "user",
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z",
  "registry_upstream": {
    "id": 1,
    "registry_id": 1,
    "position": 1
  }
}

Retrieve an upstream registry

Retrieves a specified upstream container registry.

GET /virtual_registries/container/upstreams/:id

Parameters:

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the upstream registry.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/upstreams/1"

Example response:

{
  "id": 1,
  "group_id": 5,
  "url": "https://registry-1.docker.io",
  "name": "Docker Hub",
  "description": "Docker Hub registry",
  "cache_validity_hours": 24,
  "username": "user",
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z",
  "registry_upstreams": [
    {
      "id": 1,
      "registry_id": 1,
      "position": 1
    }
  ]
}

Update an upstream registry

Updates a specified upstream container registry.

PATCH /virtual_registries/container/upstreams/:id

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the upstream registry.
`cache_validity_hours`	integer	No	The cache validity period for container images. Defaults to 24 hours.
`description`	string	No	The description of the upstream registry.
`name`	string	No	The name of the upstream registry.
`password`	string	No	The password of the upstream registry.
`url`	string	No	The URL of the upstream registry.
`username`	string	No	The username of the upstream registry.

You must provide at least one of the optional parameters in your request.

The username and password must be provided together, or not at all. If not set, a public (anonymous) request is used to access the upstream.

Example request:

curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"cache_validity_hours": 72}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/upstreams/1"

If successful, returns a 200 OK status code.

Update an upstream registry position

Updates the position of an upstream container registry in an ordered list for a container virtual registry.

PATCH /virtual_registries/container/registry_upstreams/:id

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the upstream registry association.
`position`	integer	Yes	The position of the upstream registry. Between 1 and 20.

Example request:

curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"position": 5}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/registry_upstreams/1"

If successful, returns a 200 OK status code.

Delete an upstream registry

Deletes a specified upstream container registry.

DELETE /virtual_registries/container/upstreams/:id

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the upstream registry.

Example request:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/upstreams/1"

If successful, returns a 204 No Content status code.

Associate an upstream with a registry

Associates a specified upstream container registry with a specified container virtual registry.

POST /virtual_registries/container/registry_upstreams

Attribute	Type	Required	Description
`registry_id`	integer	Yes	The ID of the container virtual registry.
`upstream_id`	integer	Yes	The ID of the container upstream registry.

You can associate a maximum of 5 upstream registries with each virtual registry.

Example request:

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --data '{"registry_id": 1, "upstream_id": 2}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/registry_upstreams"

Example response:

{
  "id": 5,
  "registry_id": 1,
  "upstream_id": 2,
  "position": 2
}

Disassociate an upstream from a registry

Removes the association between a specified upstream container registry and a specified container virtual registry.

DELETE /virtual_registries/container/registry_upstreams/:id

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the upstream registry association.

Example request:

curl --request DELETE \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/registry_upstreams/1"

If successful, returns a 204 No Content status code.

Delete cache entries for an upstream registry

Schedules all cache entries for deletion for a specified upstream registry.

DELETE /virtual_registries/container/upstreams/:id/cache

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the upstream registry.

Example request:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/upstreams/1/cache"

If successful, returns a 204 No Content status code.

Test connection to an upstream registry with override parameters

Tests the connection to an existing container upstream registry with optional parameter overrides.

This way, you can test changes to the URL, username, or password before updating the upstream registry configuration.

POST /virtual_registries/container/upstreams/:id/test

Supported attributes:

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the upstream registry.
`password`	string	No	The override password for testing.
`url`	string	No	The override URL for testing. If provided, tests connection to this URL instead of the upstream’s configured URL.
`username`	string	No	The override username for testing.

How the test works

The endpoint performs a HEAD request to the upstream URL using a test path to validate connectivity and authentication. If the upstream has a cached artifact, the relative path of the upstream is used for testing. Otherwise, a placeholder path is used.

The test behavior depends on the parameters provided:

No parameters: Tests the upstream with its current configuration (existing URL, username, and password)
URL override: Tests connectivity to the new URL (username and password must be provided together or not at all)
Credential override: Tests the existing URL with new credentials

The response received from the HEAD request is interpreted as follows:

Upstream Response	Meaning	Result
2XX	Success. Upstream accessible	`{ "success": true }`
404	Success. Upstream accessible, but test artifact not found	`{ "success": true }`
401	Authentication failed	`{ "success": false, "result": "Error: 401 - Unauthorized" }`
403	Access forbidden	`{ "success": false, "result": "Error: 403 - Forbidden" }`
5XX	Upstream server error	`{ "success": false, "result": "Error: 5XX - Server Error" }`
Network errors	Connection or timeout issues	`{ "success": false, "result": "Error: Connection timeout" }`

Both 2XX (found) and 404 Not Found responses indicate successful connectivity and authentication to the upstream registry. The test does not validate whether a specific artifact exists.

Example request (test existing configuration):

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/upstreams/1/test"

Example request (test with URL override and no credentials):

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"url": "https://registry-1.docker.io"}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/upstreams/1/test"

Example request (test with URL and credential override):

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"url": "https://registry-1.docker.io", "username": "<newuser>", "password": "<newpass>"}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/upstreams/1/test"

Example request (test with credential override):

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"username": "<newuser>", "password": "<newpass>"}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/upstreams/1/test"

Example response:

{
  "success": true
}

Manage cache entries

Use the following endpoints to manage cached container images and manifests for a container virtual registry.

List upstream registry cache entries

Lists cached container images and manifests for a container upstream registry.

GET /virtual_registries/container/upstreams/:id/cache_entries

Supported attributes:

Attribute	Type	Required	Description
`id`	integer	Yes	The ID of the upstream registry.
`page`	integer	No	The page number. Defaults to 1.
`per_page`	integer	No	The number of items per page. Defaults to 20.
`search`	string	No	The search query for the relative path of the container image (for example, `library/nginx`).

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/upstreams/1/cache_entries?search=library/nginx"

Example response:

[
  {
    "id": "MTUgbGlicmFyeS9uZ2lueC9tYW5pZmVzdC9zaGEyNTY6YWJjZGVmZ2hpams=",
    "group_id": 5,
    "upstream_id": 1,
    "upstream_checked_at": "2024-05-30T12:28:27.855Z",
    "file_md5": "44f21d5190b5a6df8089f54799628d7e",
    "file_sha1": "74d101856d26f2db17b39bd22d3204021eb0bf7d",
    "size": 2048,
    "relative_path": "library/nginx/manifests/latest",
    "content_type": "application/vnd.docker.distribution.manifest.v2+json",
    "upstream_etag": "\"686897696a7c876b7e\"",
    "created_at": "2024-05-30T12:28:27.855Z",
    "updated_at": "2024-05-30T12:28:27.855Z",
    "downloads_count": 5,
    "downloaded_at": "2024-06-05T14:58:32.855Z"
  }
]

Delete an upstream registry cache entry

Deletes a specified cached container image or manifest for an upstream registry.

DELETE /virtual_registries/container/cache_entries/*id

Attribute	Type	Required	Description
`id`	string	Yes	The cache entry ID which is the base64-encoded upstream ID and relative path of the cache entry (for example, ‘bGlicmFyeS9uZ2lueC9tYW5pZmVzdHMvbGF0ZXN0’).

Example request:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/container/cache_entries/bGlicmFyeS9uZ2lueC9tYW5pZmVzdHMvbGF0ZXN0"

If successful, returns a 204 No Content status code.