Get SMTP Status

Version 4.0.24.18

Get current SMTP status.

Request

GET /smtp_status
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
fields
string
Include only these fields in the response

Response

200: SMTP Status

Datatype
Description
(object)
is_valid
boolean
Overall SMTP status of cluster
node_count
integer
Total number of nodes in cluster
node_status
Expand SmtpNodeStatus definition...
is_valid
boolean
SMTP status of node
message
string
Error message for node
hostname
string
Host name of node

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link