Registry

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

Response Body

`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"
  }'

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"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

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

Response Body

`application/json`

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

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

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

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?|null

username?string

Length1 <= length

password?string

Length1 <= length

registryUrl?string

createdAt?string

registryType?string

Value in"cloud"

organizationId?string

Length1 <= length

serverId?string

Response Body

`application/json`

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

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

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Registry all

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/registry.all"

curl -X GET "https://your-dokploy-instance.com/api/registry.all"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

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`

curl -X GET "https://your-dokploy-instance.com/api/registry.one?registryId=string"

curl -X GET "https://your-dokploy-instance.com/api/registry.one?registryId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Registry test Registry

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

Response Body

`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"
  }'

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"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Registry test Registry By Id

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

serverId?string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/registry.testRegistryById" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://your-dokploy-instance.com/api/registry.testRegistryById" \  -H "Content-Type: application/json" \  -d '{}'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`