Skip to content
ShipSquares

/apps/{appId}/domains (POST)

POST
/apps/{appId}/domains
 
curl --request POST \
  --url https://example.com/api/v1/apps/example/domains \
  --header 'Content-Type: application/json' \
  --data '{ "fqdn": "example", "https": true }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
appId
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
fqdn
required
string
>= 1 characters <= 253 characters
https
boolean
Example generated
{
  "fqdn": "example",
  "https": true
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Default Response

Media type application/json
object
id
required
string
appId
required
string
fqdn
required
string
https
required
boolean
certStatus
required
Any of:
string
Allowed values: pending
isPrimary
required
boolean
createdAt
required
string format: date-time
Example 
{
  "certStatus": "pending"
}

404

Section titled “404 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

409

Section titled “409 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}