Dokploy

registry

POST/registry.create

registry-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

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: "selfHosted" | "cloud"

imagePrefix
Required
string | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/registry.create" \
  -d '{
  "registryName": "string",
  "username": "string",
  "password": "string",
  "registryUrl": "string",
  "registryType": "selfHosted",
  "imagePrefix": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/registry.remove

registry-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

registryId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/registry.remove" \
  -d '{
  "registryId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/registry.update

registry-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

registryId
Required
string

Minimum length: 1

registryNamestring

Minimum length: 1

imagePrefixstring | null

usernamestring

Minimum length: 1

passwordstring

Minimum length: 1

registryUrlstring

Minimum length: 1

createdAtstring

registryTypestring

Value in: "selfHosted" | "cloud"

adminIdstring

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/registry.update" \
  -d '{
  "registryId": "string",
  "registryName": "string",
  "imagePrefix": "string",
  "username": "string",
  "password": "string",
  "registryUrl": "string",
  "createdAt": "string",
  "registryType": "selfHosted",
  "adminId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/registry.all

registry-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/registry.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/registry.one

registry-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

registryId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/registry.one?registryId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/registry.testRegistry

registry-testRegistry

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

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: "selfHosted" | "cloud"

imagePrefixstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/registry.testRegistry" \
  -d '{
  "registryName": "string",
  "username": "string",
  "password": "string",
  "registryUrl": "string",
  "registryType": "selfHosted",
  "imagePrefix": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/registry.enableSelfHostedRegistry

registry-enableSelfHostedRegistry

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

registryUrl
Required
string

Minimum length: 1

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/registry.enableSelfHostedRegistry" \
  -d '{
  "registryUrl": "string",
  "username": "string",
  "password": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

On this page