Dokploy

domain

POST/domain.create

domain-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

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"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/domain.create" \
  -d '{
  "host": "string",
  "path": "string",
  "port": 1,
  "https": true,
  "applicationId": "string",
  "certificateType": "letsencrypt",
  "composeId": "string",
  "serviceName": "string",
  "domainType": "compose"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/domain.byApplicationId

domain-byApplicationId

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/domain.byApplicationId?applicationId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/domain.byComposeId

domain-byComposeId

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/domain.byComposeId?composeId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/domain.generateDomain

domain-generateDomain

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/domain.generateDomain" \
  -d '{
  "appName": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/domain.update

domain-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

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

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/domain.update" \
  -d '{
  "host": "string",
  "path": "string",
  "port": 1,
  "https": true,
  "certificateType": "letsencrypt",
  "serviceName": "string",
  "domainType": "compose",
  "domainId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/domain.one

domain-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

domainId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/domain.one?domainId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/domain.delete

domain-delete

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

domainId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/domain.delete" \
  -d '{
  "domainId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

On this page