Domain

POST

/domain.create

Domain create

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`host`
Required
string

Minimum length: 1

`path`string | null

Minimum length: 1

`port`number | null

Minimum: 1Maximum: 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

curl -X POST "https://your-dokploy-instance.com/api/domain.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "host": "string",
    "path": "string",
    "port": 1,
    "https": true,
    "applicationId": "string",
    "certificateType": "letsencrypt",
    "customCertResolver": "string",
    "composeId": "string",
    "serviceName": "string",
    "domainType": "compose",
    "previewDeploymentId": "string",
    "internalPath": "string",
    "stripPath": true
  }'

Successful response

{}

GET

/domain.byApplicationId

Domain by Application Id

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`applicationId`
Required
string

curl -X GET "https://your-dokploy-instance.com/api/domain.byApplicationId?applicationId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET

/domain.byComposeId

Domain by Compose Id

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`composeId`
Required
string

Minimum length: 1

curl -X GET "https://your-dokploy-instance.com/api/domain.byComposeId?composeId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/domain.generateDomain

Domain generate Domain

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`appName`
Required
string

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/domain.generateDomain" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appName": "string",
    "serverId": "string"
  }'

Successful response

{}

GET

/domain.canGenerateTraefikMeDomains

Domain can Generate Traefik Me Domains

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`serverId`
Required
string

curl -X GET "https://your-dokploy-instance.com/api/domain.canGenerateTraefikMeDomains?serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/domain.update

Domain update

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`host`
Required
string

Minimum length: 1

`path`string | null

Minimum length: 1

`port`number | null

Minimum: 1Maximum: 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`
Required
string

curl -X POST "https://your-dokploy-instance.com/api/domain.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "host": "string",
    "path": "string",
    "port": 1,
    "https": true,
    "certificateType": "letsencrypt",
    "customCertResolver": "string",
    "serviceName": "string",
    "domainType": "compose",
    "internalPath": "string",
    "stripPath": true,
    "domainId": "string"
  }'

Successful response

{}

GET

/domain.one

Domain one

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`domainId`
Required
string

curl -X GET "https://your-dokploy-instance.com/api/domain.one?domainId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/domain.delete

Domain delete

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`domainId`
Required
string

curl -X POST "https://your-dokploy-instance.com/api/domain.delete" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "domainId": "string"
  }'

Successful response

{}

POST

/domain.validateDomain

Domain validate Domain

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`domain`
Required
string

`serverIp`string

curl -X POST "https://your-dokploy-instance.com/api/domain.validateDomain" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "string",
    "serverIp": "string"
  }'

Successful response

{}

Body

Authorization<token>

hostRequiredstring

pathstring | null

portnumber | null

httpsboolean

applicationIdstring | null

certificateTypestring

customCertResolverstring | null

composeIdstring | null

serviceNamestring | null

domainTypestring | null

previewDeploymentIdstring | null

internalPathstring | null

stripPathboolean

Response

TypeScript

Query

Authorization<token>

applicationIdRequiredstring

Response

TypeScript

Query

Authorization<token>

composeIdRequiredstring

Response

TypeScript

Body

Authorization<token>

appNameRequiredstring

serverIdstring

Response

TypeScript

Query

Authorization<token>

serverIdRequiredstring

Response

TypeScript

Body

Authorization<token>

hostRequiredstring

pathstring | null

portnumber | null

httpsboolean

certificateTypestring

customCertResolverstring | null

serviceNamestring | null

domainTypestring | null

internalPathstring | null

stripPathboolean

domainIdRequiredstring

Response

TypeScript

Query

Authorization<token>

domainIdRequiredstring

Response

TypeScript

Body

Authorization<token>

domainIdRequiredstring

Response

TypeScript

Body

Authorization<token>

domainRequiredstring

serverIpstring

Response

TypeScript

`Authorization`<token>

`host`
Required
string

`path`string | null

`port`number | null

`https`boolean

`applicationId`string | null

`certificateType`string

`customCertResolver`string | null

`composeId`string | null

`serviceName`string | null

`domainType`string | null

`previewDeploymentId`string | null

`internalPath`string | null

`stripPath`boolean

`Authorization`<token>

`applicationId`
Required
string

`Authorization`<token>

`composeId`
Required
string

`Authorization`<token>

`appName`
Required
string

`serverId`string

`Authorization`<token>

`serverId`
Required
string

`Authorization`<token>

`host`
Required
string

`path`string | null

`port`number | null

`https`boolean

`certificateType`string

`customCertResolver`string | null

`serviceName`string | null

`domainType`string | null

`internalPath`string | null

`stripPath`boolean

`domainId`
Required
string

`Authorization`<token>

`domainId`
Required
string

`Authorization`<token>

`domainId`
Required
string

`Authorization`<token>

`domain`
Required
string

`serverIp`string