Dokploy

Registry

POST
/registry.create

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

registryName*string
Length1 <= length
username*string
Length1 <= length
password*string
Length1 <= length
registryUrl*string
registryType*string
Value in"cloud"
imagePrefix*string|null
serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/registry.create" \  -H "Content-Type: application/json" \  -d '{    "registryName": "string",    "username": "string",    "password": "string",    "registryUrl": "string",    "registryType": "cloud",    "imagePrefix": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/registry.remove

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

registryId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/registry.remove" \  -H "Content-Type: application/json" \  -d '{    "registryId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/registry.update

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

registryId*string
Length1 <= length
registryName?string
Length1 <= length
imagePrefix?string|null
username?string
Length1 <= length
password?string
Length1 <= length
registryUrl?string
createdAt?string
registryType?string
Value in"cloud"
organizationId?string
Length1 <= length
serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/registry.update" \  -H "Content-Type: application/json" \  -d '{    "registryId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/registry.all

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/registry.all"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/registry.one

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

registryId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/registry.one?registryId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/registry.testRegistry

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

registryName?string
username*string
Length1 <= length
password*string
Length1 <= length
registryUrl*string
registryType*string
Value in"cloud"
imagePrefix?string|null
serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/registry.testRegistry" \  -H "Content-Type: application/json" \  -d '{    "username": "string",    "password": "string",    "registryUrl": "string",    "registryType": "cloud"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Redis

Previous Page

Rollback

Next Page