Skip to main content
POST
/
v2
/
sandboxes
/
registries
Register a Private Container Registry
curl --request POST \
  --url https://api.example.com/v2/sandboxes/registries \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "username": "<string>",
  "password": "<string>"
}
'
{
  "name": "<string>",
  "url": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Body

application/json

Request model for registering a private container registry.

Accepts structured credential fields. The backend constructs the .dockerconfigjson K8s secret internally.

​
name
string
required

Name of the registry (max 63 chars, DNS-1035 format: lowercase alphanumeric and hyphens, must start with letter)

​
url
string
required

Registry URL (e.g. https://index.docker.io/v1/, ghcr.io)

Example:

"https://index.docker.io/v1/"

​
username
string
required

Username for authenticating with the registry

​
password
string
required

Password or access token for authenticating with the registry

Response

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