Add a registry login for every environment of the organization. An environment's own login for the same registry wins.

POST

/api/v1/registries

curl --request POST \
  --url https://example.com/api/v1/registries \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "preset": "dockerhub", "server": "example", "username": "example", "password": "example" }'

Request Body^required

Media typeapplication/json

object

name

required

Unique in the organization: lowercase letters, digits and -.

string

preset

required

string

Allowed values: dockerhub ghcr gitlab quay harbor custom

server

Required unless the preset names its server.

string

username

required

string

password

required

A password or access token; write-only.

string

Responses

201

Media typeapplication/json

An organization’s login for one registry, used by every environment without a login of its own for that registry. The password is never returned.

object

id

required

string

name

required

string

preset

required

string

Allowed values: dockerhub ghcr gitlab quay harbor custom

server

required

The registry as image references name it (ghcr.io, docker.io, registry.example.com:5000).

string

username

required

string

hasPassword

required

boolean

createdAt

required

integer format: int64

updatedAt

required

integer format: int64

lastCheckedAt

integer | null format: int64

lastError

string | null

Example

{
  "preset": "dockerhub"
}

403

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

409

The name or registry is taken

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

422

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

503

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}