Update a Registry

Update a registry’s display name and/or credentials.

You can update:

• name: New display name (must be unique within the organization)
• url, username, password: New credentials (all three must be provided together)

PATCH /v2/sandboxes/registries/{name}

Update a Registry

cURL

curl --request PATCH \
  --url https://api.example.com/v2/sandboxes/registries/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "username": "<string>",
  "password": "<string>"
}
'

200

{
  "name": "<string>",
  "url": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Path Parameters

name · string · required

Registry name

Body

application/json

Request model for updating a private container registry.

You can update the display name alone, or update credentials (url + username + password must all be provided together).

name · string | null

New display name for the registry (max 63 chars, DNS-1035 format). Must be unique within the organization.

url · string | null

New registry URL

username · string | null

New username for authenticating with the registry

password · string | null

New password or access token for authenticating with the registry

Response

200

application/json

Successful Response

Response model for a private container registry.

Credentials are never included in responses.

name · string · required

url · string · required

Primary registry URL extracted from docker config

id · string<uuid> | null

Unique registry identifier

created_at · string | null

updated_at · string | null