DELETE
/api/admin/api-keys/{api_key_id}/transportsAdminRemove a transport from an API key's allowed-transports scope
With zero entries the transport dimension is unrestricted; otherwise the send's resolved transport (explicit or deployment default) must be an entry.
operationId
removeApiKeyTransportAdmin: API KeysAuthentication & 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 |
|---|---|---|
| api_key_id* | string (uuid) | ID of the API key. |
Request body
Required
application/json
ApiKeyTransportMutationBody
| Property | Type | Description |
|---|---|---|
| transport_id* | MailTransportKind | A mail transport this server knows about. |
JSONExample
"transport_id""resend"
Responses
application/json
SuccessMessageResponseSuccess envelope for operations with no response payload.
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string |
JSONExample
"success"true
"message""string"
Example request
bashcurl
curl -X DELETE 'https://mail.schemavaults.com/api/admin/api-keys/<api_key_id>/transports' \
-H 'Authorization: Bearer <access_token>' \
-H 'Content-Type: application/json' \
-d '{
"transport_id": "resend"
}'