API Keys

Archive API Key certificate [EXPERIMENTAL]

This operation archives an active certificate of the API Key, identified by the certificateKey that was returned when it was added. It stays in the list with the status archived and is no longer accepted for authentication. Archiving frees one of the two active certificate slots, which is the last step of rotating a certificate.

The last active certificate of an API Key with mTLS enabled can't be archived.

The change takes a short time to take effect, so an archived certificate can still be accepted for a while.

Requires apiKeys:Archive permission.

delete/apiKeys/{apiKey}/certificates/{certificateKey}

Request

Path parameters

apiKeystring required

Uniquely identifies an API Key

Example:apk-1UF2NafdfrdPMf2XrS2

Uniquely identifies an API Key.

certificateKeystring required

Uniquely identifies a certificate bound to an API Key

Example:crt-602nkAxGfhDN8yQBibpx

Uniquely identifies a certificate bound to an API Key. It is the certificateKey returned when the certificate was added.

Response

Certificate archived successfully

Changes

No recorded changes to this operation across all 1 revision of this API.