Change a registry login; a new password rotates it.

PUT

/api/v1/registries/{registry}

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

Parameters

Path Parameters

registry

required

string

Registry id or name

Request Body^required

Media typeapplication/json

Only the members given change; a new password rotates the login.

object

name

string

server

string

username

string

password

Write-only.

string

Example^generated

{
  "name": "example",
  "server": "example",
  "username": "example",
  "password": "example"
}

Responses

200

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"
}

404

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"
}