Skip to content
ShipSquares

/mail/instances/{id}/domains (POST)

POST
/mail/instances/{id}/domains
 
curl --request POST \
  --url https://example.com/api/v1/mail/instances/example/domains \
  --header 'Content-Type: application/json' \
  --data '{ "fqdn": "example", "dnsMode": "auto" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
fqdn
required
string
>= 3 characters <= 253 characters
dnsMode
Any of:
string
Allowed values: auto

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Default Response

Media type application/json
object
domain
required
object
id
required
string
mailInstanceId
required
string
fqdn
required
string
dkimSelector
required
string
dnsMode
required
string
verificationStatus
required
string
inboxSubdomain
required
string
createdAt
required
string
records
required
Array<object>
object
id
required
string
kind
required
string
name
required
string
type
required
string
value
required
string
priority
required
Any of:
integer
status
required
string
detail
required
Any of:
string
Example generated
{
  "domain": {
    "id": "example",
    "mailInstanceId": "example",
    "fqdn": "example",
    "dkimSelector": "example",
    "dnsMode": "example",
    "verificationStatus": "example",
    "inboxSubdomain": "example",
    "createdAt": "example"
  },
  "records": [
    {
      "id": "example",
      "kind": "example",
      "name": "example",
      "type": "example",
      "value": "example",
      "priority": 1,
      "status": "example",
      "detail": "example"
    }
  ]
}

400

Section titled “400 ”

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"
    }
  ]
}

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"
    }
  ]
}