Credentials

Create credential

post

Create a new container registry credential

Authorizations
x-api-keystringRequired
Body

Container Registry Credential Create Request (v2)

namestring · min: 1Required

Credential name (1-20 chars, starts with letter)

Example: docker-hub-credsPattern: ^(?=[A-Za-z])[A-Za-z0-9@._-]{1,20}$
usernamestring · min: 1 · max: 255Required

Registry username

Example: myuser
passwordstring · min: 1 · max: 255Required

Registry password/token

Example: dckr_pat_...
Responses
chevron-right
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

post
/v2/container-registry-auths

Delete credential

delete

Delete a credential

Authorizations
x-api-keystringRequired
Path parameters
idinteger · int64Required
Responses
chevron-right
200

Credential deleted

*/*
messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

delete
/v2/container-registry-auths/{id}

Update credential

patch

Update an existing credential (partial update)

Authorizations
x-api-keystringRequired
Path parameters
idinteger · int64Required
Body

Container Registry Credential Update Request (v2)

namestring · min: 1 · max: 20Optional

Credential name (1-20 chars, starts with letter)

Example: docker-hub-creds-updated
usernamestring · min: 1 · max: 255Optional

Registry username

Example: myuser
passwordstring · min: 1 · max: 255Optional

Registry password/token

Example: dckr_pat_...
Responses
chevron-right
200

Credential updated

*/*
messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

patch
/v2/container-registry-auths/{id}

Get credential

get

Get details of a specific credential

Authorizations
x-api-keystringRequired
Path parameters
idinteger · int64Required
Responses
chevron-right
200

Credential found

*/*
messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

get
/v2/container-registry-auths/{id}

List credentials

get

Get all credentials for your organization

Authorizations
x-api-keystringRequired
Responses
chevron-right
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

get
/v2/container-registry-auths

Last updated

Was this helpful?