Dokploy
Generated

Registry

POST
/registry.create

Registry create

/registry.create

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

registryName
Required
string

Minimum length: 1

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1

registryUrl
Required
string

registryType
Required
string

Value in: "cloud"

imagePrefix
Required
string | null

serverIdstring

curl -X POST "https://your-dokploy-instance.com/api/registry.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "registryName": "string",
    "username": "string",
    "password": "string",
    "registryUrl": "string",
    "registryType": "cloud",
    "imagePrefix": "string",
    "serverId": "string"
  }'

Successful response

{}

POST
/registry.remove

Registry remove

/registry.remove

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

registryId
Required
string

Minimum length: 1
curl -X POST "https://your-dokploy-instance.com/api/registry.remove" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "registryId": "string"
  }'

Successful response

{}

POST
/registry.update

Registry update

/registry.update

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

registryId
Required
string

Minimum length: 1

registryNamestring

Minimum length: 1

imagePrefixstring | null

usernamestring

Minimum length: 1

passwordstring

Minimum length: 1

registryUrlstring

createdAtstring

registryTypestring

Value in: "cloud"

organizationIdstring

Minimum length: 1

serverIdstring

curl -X POST "https://your-dokploy-instance.com/api/registry.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "registryId": "string",
    "registryName": "string",
    "imagePrefix": "string",
    "username": "string",
    "password": "string",
    "registryUrl": "string",
    "createdAt": "string",
    "registryType": "cloud",
    "organizationId": "string",
    "serverId": "string"
  }'

Successful response

{}

GET
/registry.all

Registry all

/registry.all

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/registry.all" \
  -H "Authorization: <token>"

Successful response

{}

GET
/registry.one

Registry one

/registry.one

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

registryId
Required
string

Minimum length: 1
curl -X GET "https://your-dokploy-instance.com/api/registry.one?registryId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST
/registry.testRegistry

Registry test Registry

/registry.testRegistry

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

registryNamestring

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1

registryUrl
Required
string

registryType
Required
string

Value in: "cloud"

imagePrefixstring | null

serverIdstring

curl -X POST "https://your-dokploy-instance.com/api/registry.testRegistry" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "registryName": "string",
    "username": "string",
    "password": "string",
    "registryUrl": "string",
    "registryType": "cloud",
    "imagePrefix": "string",
    "serverId": "string"
  }'

Successful response

{}

Previous

Redis

Next

Rollback