/mail/instances (POST)

POST

/mail/instances

curl --request POST \
  --url https://example.com/api/v1/mail/instances \
  --header 'Content-Type: application/json' \
  --data '{ "catalogServiceId": "example", "serverId": "example", "hostname": "example", "adminSecret": "example", "storeBackend": "managed_pg", "metadataDbId": "example" }'

Request Body ^required

Media type application/json

object

catalogServiceId

required

string

>= 1 characters

serverId

required

string

>= 1 characters

hostname

required

string

>= 1 characters <= 253 characters

adminSecret

required

string

>= 1 characters <= 1024 characters

storeBackend

Any of:

string

string

Allowed values: managed_pg

string

string

Allowed values: filesystem

metadataDbId

string

Responses

201

Default Response

Media type application/json

object

id

required

string

catalogServiceId

required

string

serverId

required

string

hostname

required

string

storeBackend

required

string

status

required

string

port25Egress

required

string

ptrOk

required

Any of:

boolean

boolean

null

null

createdAt

required

string

Example ^generated

{
  "id": "example",
  "catalogServiceId": "example",
  "serverId": "example",
  "hostname": "example",
  "storeBackend": "example",
  "status": "example",
  "port25Egress": "example",
  "ptrOk": true,
  "createdAt": "example"
}

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