Cloady Docs
API ReferenceEndpointsApplications

Check a mail service's domains and reputation

Finds the domains the service sends from (Postfix's log and myorigin, or Stalwart's own domain list) and checks each in public DNS: SPF evaluated against the address the mail leaves from, DKIM keys for the selectors seen signing, DMARC policy and MX. Also reverse DNS of that address, the certificate offered after STARTTLS, and the address on Spamhaus, Barracuda, SpamCop and UCEPROTECT, and for Stalwart the DMARC aggregate reports it received. The address belongs to the node and is shared by every app on it. Runs the checks on every call.

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/services/{serviceName}/mail/domains

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string
serviceName*string

Query Parameters

env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string
domain?array<>

Extra sending domains to check; repeat for several

Itemsitems <= 5
selector?array<>

DKIM selectors to look up on every domain; repeat for several

Itemsitems <= 5

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/apps/string/services/string/mail/domains"
{  "at": 0,  "egress": {    "ip": "string",    "node": "string",    "ptr": "string",    "confirmed": true  },  "domains": [    {      "domain": "string",      "source": "logs",      "messages": 0,      "spf": {        "result": "pass",        "record": "string"      },      "dmarc": {        "policy": "string",        "record": "string",        "rua": [          "string"        ]      },      "dkim": [        {          "selector": "string",          "found": true,          "source": "logs"        }      ],      "mx": [        "string"      ]    }  ],  "tls": {    "port": 0,    "subject": "string",    "validTo": 0,    "error": "string"  },  "blocklists": [    {      "name": "string",      "zone": "string",      "status": "clean",      "code": "string",      "delist": "string"    }  ],  "dmarcReports": [    {      "reporter": "string",      "domain": "string",      "reports": 0,      "messages": 0,      "aligned": 0,      "sources": 0,      "quarantined": 0,      "rejected": 0,      "end": 0    }  ],  "notes": [    "string"  ]}

Retry queued mail now POST

Asks Postfix to attempt delivery now, for one queued message (`postqueue -i`) or the whole queue (`postqueue -f`), instead of waiting for its retry time. Requires the developer role.

List an app's alert rules GET

Returns the app's alert rules with their state, the services they are firing on and when each last fired. Rules live in the app's own alerting tenant, evaluated once a minute. A production app gets two default rules the first time its alerts are read: down for 2 minutes, and more than 3 restarts within 15 minutes, both emailing members. With `service`, only rules that watch that compose service, and state for it alone.