Information
- OpenAPI version:
3.1.0
Overview
mailserver control plane 0.15.0
Section titled “mailserver control plane 0.15.0”REST API for domains, mailboxes, aliases, setup and server configuration. Breaking changes bump the /api/v1 prefix.
Operations
Section titled “Operations”GET
/healthGET
/setupPUT
/setup/tlsPOST
/setup/domainPOST
/setup/ownerGET
/setup/aiPUT
/setup/aiDELETE
/setup/aiPOST
/setup/ai/testPOST
/setup/completePOST
/setup/answersPOST
/auth/loginPOST
/auth/handoffPOST
/auth/refreshPOST
/auth/logoutGET
/auth/mePOST
/auth/totp/setupDELETE
/auth/sessions/{id}GET
/domainsPOST
/domainsDELETE
/domains/{id}PATCH
/domains/{id}DELETE
/mailboxes/{id}PATCH
/mailboxes/{id}DELETE
/aliases/{id}PATCH
/aliases/{id}DELETE
/forwarders/{id}PATCH
/forwarders/{id}DELETE
/domains/{id}/catchallGET
/auditGET
/licenseGET
/usersPOST
/usersPATCH
/users/{id}GET
/tokensPOST
/tokensDELETE
/tokens/{id}GET
/auth-bansDELETE
/auth-bans/{id}GET
/alertsGET
/queuePOST
/queue/actionsGET
/messagesPOST
/messagesGET
/ai/configPUT
/ai/configDELETE
/ai/configPOST
/ai/config/testGET
/ai/limitPUT
/ai/limitDELETE
/ai/domains/{id}/limitDELETE
/ai/mailboxes/{id}/limitGET
/ai/opt-inPUT
/ai/opt-inGET
/ai/logPOST
/ai/explainPOST
/ai/repliesGET
/brandingPUT
/brandingDELETE
/branding/logoGET
/migrationsPOST
/migrationsDELETE
/migrations/{id}DELETE
/mail/account/avatarPOST
/mail/foldersDELETE
/mail/foldersPOST
/mail/uploadsPOST
/mail/sendPOST
/mail/scheduledDELETE
/mail/scheduled/{id}PATCH
/mail/scheduled/{id}PUT
/mail/draftsGET
/Authentication
Section titled “Authentication”bearer
Section titled “bearer”JWT access token or msk_… API token
Security scheme type: http