Documentation Index

Fetch the complete documentation index at: https://support.fortanix.com/llms.txt

Use this file to discover all available pages before exploring further.

Transition a security object to Deactivated or Compromised state.

Prev Next
Post
/crypto/v1/keys/{key_id}/revoke

Transition a security object to Deactivated or Compromised state.

Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization

Please enter your token prefixed with 'Basic ' (e.g., 'Basic your_token_here')

Path parameters
key_id
string (uuid) Required
Body parameters
object
code
string Required

Reasons to revoke a security object.

Valid values[ "Unspecified", "KeyCompromise", "CACompromise", "AffiliationChanged", "Superseded", "CessationOfOperation", "PrivilegeWithdrawn" ]
message
string | null

Message is used exclusively for audit trail/logging purposes and MAY contain additional information about why the object was revoked.

compromise_occurance_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
Responses
204

Nothing is returned on success