GET
/api/admin/transportsAdminList mail transports with configured/default status
operationId
listTransportsAdmin: TransportsAuthentication & permissionsAdmin
Platform administrators only
- Accepted credentials
- Access token (Bearer)
Authorization: Bearer <JWT> - Access token (cookie)
cookie "access_token_schemavaults-mail"
- Access token (Bearer)
- Who may call
- Platform administrators only
Responses
application/json
| Property | Type | Description |
|---|---|---|
| success* | true | |
| data* | TransportStatus[] | |
| id* | MailTransportKind | A mail transport this server knows about. |
| configured* | boolean | Whether the transport's env vars are present on this deployment. |
| is_default* | boolean | Whether MAIL_TRANSPORT selects this transport when a send request omits |
| enabled* | boolean | Whether an admin has left this transport enabled at runtime. Only the test-database-transport can currently be disabled (from /admin/transports); a disabled transport rejects sends even when configured. |
JSONExample
"success"true
"data"
"id""resend"
"configured"true
"is_default"true
"enabled"true
Example request
bashcurl
curl -X GET 'https://mail.schemavaults.com/api/admin/transports' \
-H 'Authorization: Bearer <access_token>'