Dokploy
Generated

Domain

POST
/domain.create

Domain create

/domain.create

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

host
Required
string

Minimum length: 1

pathstring | null

Minimum length: 1

portnumber | null

Minimum: 1Maximum: 65535

httpsboolean

applicationIdstring | null

certificateTypestring

Value in: "letsencrypt" | "none"

composeIdstring | null

serviceNamestring | null

domainTypestring | null

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

Successful response

GET
/domain.byApplicationId

Domain by Application Id

/domain.byApplicationId

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

applicationId
Required
string

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

Successful response

GET
/domain.byComposeId

Domain by Compose Id

/domain.byComposeId

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

composeId
Required
string

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

Successful response

POST
/domain.generateDomain

Domain generate Domain

/domain.generateDomain

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

appName
Required
string

serverIdstring

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

Successful response

POST
/domain.update

Domain update

/domain.update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

host
Required
string

Minimum length: 1

pathstring | null

Minimum length: 1

portnumber | null

Minimum: 1Maximum: 65535

httpsboolean

certificateTypestring

Value in: "letsencrypt" | "none"

serviceNamestring | null

domainTypestring | null

Value in: "compose" | "application"

domainId
Required
string

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

Successful response

GET
/domain.one

Domain one

/domain.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

domainId
Required
string

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

Successful response

POST
/domain.delete

Domain delete

/domain.delete

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

domainId
Required
string

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

Successful response

Previous

Docker

Next

Github