Credentials

Create credential

post

Create a new container registry credential

Authorizations

x-api-key

x-api-keystringRequired

Body

application/json

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

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Invalid request

*/*

500

Internal Server Error

*/*

post/v2/container-registry-auths

HTTPcURLJavaScriptPython

POST /v2/container-registry-auths HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "name": "docker-hub-creds",
  "username": "my-user",
  "password": "thisisapassword"
}

{
  "message": "success",
  "code": 10000,
  "data": {
    "id": "454591571947143492",
    "name": "docker-hub-creds"
  }
}

Delete credential

delete

Delete a credential

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 454591571947143500

Responses

200

Credential deleted

*/*

messagestringOptional

message

Example: success

codeinteger · int32Optional

code

Example: 10000

dataanyOptional

data

400

Bad Request

*/*

409

Credential in use

*/*

500

Internal Server Error

*/*

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

HTTPcURLJavaScriptPython

DELETE /v2/container-registry-auths/{id} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "success",
  "code": 10000,
  "data": null
}

Update credential

patch

Update an existing credential (partial update)

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 454591571947143500

Body

application/json

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

200

Credential updated

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

404

Credential not found

*/*

500

Internal Server Error

*/*

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

HTTPcURLJavaScriptPython

PATCH /v2/container-registry-auths/{id} HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "name": "docker-hub-creds-upd",
  "username": "my-user",
  "password": "thisistheupdatedpassword"
}

{
  "message": "success",
  "code": 10000,
  "data": {
    "id": "454591571947143492",
    "name": "docker-hub-creds-upd"
  }
}

Get credential

get

Get details of a specific credential

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 454591571947143500

Responses

200

Credential found

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

404

Credential not found

*/*

500

Internal Server Error

*/*

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

HTTPcURLJavaScriptPython

GET /v2/container-registry-auths/{id} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "success",
  "code": 10000,
  "data": {
    "id": "454591571947143492",
    "name": "docker-hub-creds"
  }
}

List credentials

get

Get all credentials for your organization

Authorizations

x-api-key

x-api-keystringRequired

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

500

Internal Server Error

*/*

get/v2/container-registry-auths

HTTPcURLJavaScriptPython

GET /v2/container-registry-auths HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "success",
  "code": 10000,
  "data": [
    {
      "id": "454591571947143492",
      "name": "docker-hub-creds"
    }
  ]
}