Servers

SMTP server configuration

List Servers

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

namestringRequired

hoststringRequired

portintegerRequired

use_tlsbooleanOptionalDefault: true

idintegerRequired

get

/api/servers

HTTPcURLJavaScriptPython

GET /api/servers HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

[
  {
    "name": "text",
    "host": "text",
    "port": 1,
    "use_tls": true,
    "id": 1
  }
]

Create Server

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

namestringRequired

hoststringRequired

portintegerRequired

use_tlsbooleanOptionalDefault: true

Responses

200

Successful Response

application/json

namestringRequired

hoststringRequired

portintegerRequired

use_tlsbooleanOptionalDefault: true

idintegerRequired

422

Validation Error

application/json

post

/api/servers

HTTPcURLJavaScriptPython

POST /api/servers HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "text",
  "host": "text",
  "port": 1,
  "use_tls": true
}

{
  "name": "text",
  "host": "text",
  "port": 1,
  "use_tls": true,
  "id": 1
}

Update Server

put

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

server_idintegerRequired

Body

application/json

nameany ofOptional

stringOptional

or

nullOptional

hostany ofOptional

stringOptional

or

nullOptional

portany ofOptional

integerOptional

or

nullOptional

use_tlsany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

namestringRequired

hoststringRequired

portintegerRequired

use_tlsbooleanOptionalDefault: true

idintegerRequired

422

Validation Error

application/json

put

/api/servers/{server_id}

HTTPcURLJavaScriptPython

PUT /api/servers/{server_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "text",
  "host": "text",
  "port": 1,
  "use_tls": true
}

{
  "name": "text",
  "host": "text",
  "port": 1,
  "use_tls": true,
  "id": 1
}

Delete Server

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

server_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete

/api/servers/{server_id}

HTTPcURLJavaScriptPython

DELETE /api/servers/{server_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Duplicate Server

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

server_idintegerRequired

Body

application/json

namestringRequired

Responses

200

Successful Response

application/json

namestringRequired

hoststringRequired

portintegerRequired

use_tlsbooleanOptionalDefault: true

idintegerRequired

422

Validation Error

application/json

post

/api/servers/{server_id}/duplicate

HTTPcURLJavaScriptPython

POST /api/servers/{server_id}/duplicate HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "name": "text",
  "host": "text",
  "port": 1,
  "use_tls": true,
  "id": 1
}