Revoke certificate

PUT https://www.digicert.com/services/v2/certificate/{{certificate_identifier}}/revoke
Use this endpoint to submit a request to revoke a single certificate on an order. In the endpoint path, replace certificate_identifier with the certificate ID or serial number of the certificate to revoke.

To submit a request to revoke the entire order, use the Revoke order certificates endpoint.

Skip the approval step

After submitting the request, an administrator must approve it before DigiCert can revoke the certificate.

To skip the approval step and submit the request directly to DigiCert for revocation, include "skip_approval": true in the body of your request. To skip the approval step, the API key must have admin privileges. See Authentication.

What happens if I revoke a certificate on an order with only a single certificate?

When you revoke a certificate on an order with only a single certificate:

  • The order is still active.
  • You can still reissue a certificate on that order. If you do not plan to reissue a certificate for the order, use the Revoke order certificates endpoint to submit a request to revoke the order.
  • No refund is provided for a revoked certificate on an order.

To change this behavior such that revoking the only certificate on the order also revokes the entire order, follow these steps:

  1. Sign in to your CertCentral account.
  2. In the left menu, go to Settings > Preferences.
  3. On the Preferences page, expand Advanced settings.
  4. Under Certificate Revocations (API Only), select Revoke order when all certificates are revoked. This setting only applies to the Revoke certificate endpoint in the Services API. To revert to the default behavior, select Revoke individual certificates.
  5. Scroll to the bottom of the page and click Save Settings.

Example requests and responses

curl --request PUT 'https://www.digicert.com/services/v2/certificate/{{certificate_identifier}}/revoke' \
--header 'Content-Type: application/json' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--data-raw '{
  "skip_approval": true
}'
curl --request PUT 'https://www.digicert.com/services/v2/certificate/{{certificate_identifier}}/revoke' \
--header 'Content-Type: application/json' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--data-raw '{
  "comments": "I no longer need this certificate."
}'
curl --request PUT 'https://www.digicert.com/services/v2/certificate/{{certificate_identifier}}/revoke' \
--header 'Content-Type: application/json' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--data-raw '{
  "revocation_reason": "superseded",
  "skip_approval": true
}'
// empty
{
  "id": 1,
  "date": "2016-02-10T17:06:15+00:00",
  "type": "revoke",
  "status": "pending",
  "requester": {
    "id": 242140,
    "first_name": "Jack",
    "last_name": "White",
    "email": "j.white@fakeaddy.com"
  },
  "comments": "Revoked via API!"
}

Path parameters

NameReq/OptDescription
certificate_identifierrequiredValue that identifies the certificate to revoke. Accepts the certificate ID or serial number.

Request parameters

NameReq/OptTypeDescription
commentoptionalstringMessage to associate with the revocation request. Use this field to add a comment to the request for the request approver.
Note: DigiCert only stores the comment value on revocation requests. If skip_approval is true and the requestor has admin privileges, DigiCert revokes the certificate without creating a request, and we do not store the comment value.
skip_approvaloptionalboolIf true, the revoke request skips the approval step and is immediately submitted to DigiCert for revocation. Otherwise, false (default).
Note: For skip approvals to work, the API key must have admin privileges.

Response parameters

NameTypeDescription
idintRequest ID.
datestringTimestamp of when the revoke request was submitted.
Format: UTC timezone and ISO 8601 date
typestringRequest type.
Possible values:
revoke
statusstringStatus of the revoke request.
Possible values: submitted, pending, approved, rejected
requesterobjectDetails about the user that placed the request. See Structures – User details object.
.. idintUser ID.
.. first_namestringFirst name of user.
.. last_namestringLast name of user.
.. emailstringEmail address of user.
commentsstringMessage about the revoke request.