domain

POST`/domain.create`

domain-create

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

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

`composeId`string | null

`serviceName`string | null

`domainType`string | null

Value in: "compose" | "application"

Status code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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

`path`string | null

Minimum length: 1

`port`number | null

Minimum: 1Maximum: 65535

`https`boolean

`certificateType`string

Value in: "letsencrypt" | "none"

`serviceName`string | null

`domainType`string | null

Value in: "compose" | "application"

`domainId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/domain.delete" \
  -d '{
  "domainId": "string"
}'

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

domain

POST/domain.create

AuthorizationRequiredBearer <token>

hostRequiredstring

pathstring | null

portnumber | null

httpsboolean

applicationIdstring | null

certificateTypestring

composeIdstring | null

serviceNamestring | null

domainTypestring | null

Response

Typescript

GET/domain.byApplicationId

AuthorizationRequiredBearer <token>

applicationIdRequiredstring

Response

Typescript

GET/domain.byComposeId

AuthorizationRequiredBearer <token>

composeIdRequiredstring

Response

Typescript

POST/domain.generateDomain

AuthorizationRequiredBearer <token>

appNameRequiredstring

Response

Typescript

POST/domain.update

AuthorizationRequiredBearer <token>

hostRequiredstring

pathstring | null

portnumber | null

httpsboolean

certificateTypestring

serviceNamestring | null

domainTypestring | null

domainIdRequiredstring

Response

Typescript

GET/domain.one

AuthorizationRequiredBearer <token>

domainIdRequiredstring

Response

Typescript

POST/domain.delete

AuthorizationRequiredBearer <token>

domainIdRequiredstring

Response

Typescript

On this page

POST`/domain.create`

`Authorization`
Required
Bearer <token>

`host`
Required
string

`path`string | null

`port`number | null

`https`boolean

`applicationId`string | null

`certificateType`string

`composeId`string | null

`serviceName`string | null

`domainType`string | null

GET`/domain.byApplicationId`

`Authorization`
Required
Bearer <token>

`applicationId`
Required
string

GET`/domain.byComposeId`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

POST`/domain.generateDomain`

`Authorization`
Required
Bearer <token>

`appName`
Required
string

POST`/domain.update`

`Authorization`
Required
Bearer <token>

`host`
Required
string

`path`string | null

`port`number | null

`https`boolean

`certificateType`string

`serviceName`string | null

`domainType`string | null

`domainId`
Required
string

GET`/domain.one`

`Authorization`
Required
Bearer <token>

`domainId`
Required
string

POST`/domain.delete`

`Authorization`
Required
Bearer <token>

`domainId`
Required
string