/api/admin/transports/{transport_id}AdminEnable or disable the test-database transport
Toggles a transport's runtime kill switch. Only the fake-send test-database-transport supports this — it lets an admin stop fake sending in production without a redeploy. The real delivery transports (resend, smtp) are controlled by environment variables and reject this call.
updateTransportAdmin: 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
Path parameters
| Name | Type | Description |
|---|---|---|
| transport_id* | MailTransportKind & any | The transport to update. |
Request body
Required
| Property | Type | Description |
|---|---|---|
| enabled* | boolean | Whether the transport may be used for sends. Only supported for the test-database-transport. |
Responses
| 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. |
| message* | string |
Example request
curl -X PATCH 'https://mail.schemavaults.com/api/admin/transports/<transport_id>' \
-H 'Authorization: Bearer <access_token>' \
-H 'Content-Type: application/json' \
-d '{
"enabled": true
}'