Revoke

Use this endpoint to revoke a previously issued certificate using its certId. The operation is performed with an authenticated DELETE request to the certificate resource.

Warning: Revocation is permanent and cannot be undone.

Note: This page covers the essentials. For full parameters, examples, and response schema, see Revoke certificate (API Reference).

Request

  • Authorization: Bearer <access_token> (see Authentication and Create Access Token).
  • Method: DELETE.
  • Base URL: see Base URL and Variables.
  • Path: /api/v1/certificates/{certId}.
  • Path parameter:
    • certId: the ID of the certificate to revoke (returned by enroll/renew/replace).
  • Body (JSON):
    • message: Required. Revocation reason in readable message form used for audits and notifications.
    • reasonCode: Optional. A reason code in RFC5280 format.

Response

  • Success: returns a 200 OK indicating the certificate has been revoked.

  • Failure: returns a JSON error body in the standard format: {"code": <int>, "description": "<text>"}.