Retire API Key

Deletes the existing API key immediately when the client specified by the client_guid has initiated an API key rotation. This refers to the original key that was scheduled for deletion during the rotation process. The secondary API key generated during the rotation becomes the only key available to access MX's servers. If no rotation is in progress, this endpoint returns an error.

warning

Once initiated, the process cannot be undone. The original API key will be permanently deleted and can no longer be used to access MX's servers.

POST

/clients/{client_guid}/api_keys/retire

Path Parameters

Field	Required	Type
client_guid The unique id for a client.	Required	String

Request sample

Language:shell

_10

curl -L -X POST 'https://int-api.mx.com/clients/{client_guid}/api_keys/retire' \

_10

-H 'Accept: application/vnd.mx.api.v1+json' \

_10

-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Response sample

204

Language:json

_10

No Response Body