Dokploy

Domain

POST
/domain.create

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

host*string
Length1 <= length
path?string|null
Length1 <= length
port?number|null
Range1 <= value <= 65535
https?boolean
applicationId?string|null
certificateType?string
Value in"letsencrypt" | "none" | "custom"
customCertResolver?string|null
composeId?string|null
serviceName?string|null
domainType?string|null
Value in"compose" | "application" | "preview"
previewDeploymentId?string|null
internalPath?string|null
stripPath?boolean
[key: string]?never

Response Body

application/json

application/json

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

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

applicationId*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/domain.byApplicationId?applicationId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/domain.byComposeId

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

composeId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/domain.byComposeId?composeId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/domain.generateDomain

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

appName*string
serverId?string
[key: string]?never

Response Body

application/json

application/json

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

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

serverId*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/domain.canGenerateTraefikMeDomains?serverId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/domain.update

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

host*string
Length1 <= length
path?string|null
Length1 <= length
port?number|null
Range1 <= value <= 65535
https?boolean
certificateType?string
Value in"letsencrypt" | "none" | "custom"
customCertResolver?string|null
serviceName?string|null
domainType?string|null
Value in"compose" | "application" | "preview"
internalPath?string|null
stripPath?boolean
domainId*string
[key: string]?never

Response Body

application/json

application/json

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

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

domainId*string

Response Body

application/json

application/json

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

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

domainId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/domain.delete" \  -H "Content-Type: application/json" \  -d '{    "domainId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/domain.validateDomain

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

domain*string
serverIp?string
[key: string]?never

Response Body

application/json

application/json

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

Docker

Previous Page

Environment

Next Page