The REST API

The REST API

This page began as a chapter of the 6.2.10 manual and has been corrected for 6.2.24. The Control Panel's pages are grouped differently now, so the paths below use today's groups; the TLS ports 465, 993 and 995 exist only after you create them on the TCP/IP ports page (a fresh install seeds 25, 587, 110 and 143); and everything added since 6.2.10 is in Changes Since 6.2.10. Where a value here disagrees with the Settings Reference, which is generated from the code, the reference is right.

A modern alternative to COM for automation, and the only option from a non-Windows machine.

RestApiPort=8443
RestApiBindAddress=127.0.0.1

Authentication is HTTP Basic with the administrator password. TLS is required unless bound to 127.0.0.1 — the server enforces this.

Method	Endpoint	Does
GET	/api/v1/status	Server status
GET	/api/v1/domains	List domains
GET	/api/v1/domains/<name>/accounts	List a domain's accounts
POST	/api/v1/domains/<name>/accounts	Create an account
DELETE	/api/v1/accounts/<address>	Delete an account
GET	/api/v1/queue	The delivery queue
POST	/api/v1/queue/<id>/retry	Retry a queued message
DELETE	/api/v1/queue/<id>	Delete a queued message
GET	/api/v1/tlsa	Publish-ready DANE TLSA records

curl -u Administrator:your-admin-password https://localhost:8443/api/v1/status

---