Revoke certificate

PUT
https://one.digicert.com/iot/api/v1/certificate/{{certificate_id}}/revoke

Use this endpoint to revoke a certificate.

Example requests and responses

cURL
curl --request PUT 'https://one.digicert.com/iot/api/v1/certificate/b0484486-a56b-4e37-a5de-b717c59163fa/revoke' \
--header 'x-api-key: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "reason": "key_compromise",
  "revocation_date": "2020-05-18T15:35:00Z",
  "comments": "revocation comment"
}'
204 No Content
// Certificate successfully revoked, no content returned
404 Not Found
{
  "errors": [
    {
      "code": "entity_not_found",
      "message": "Certificate with id da39ba51-b556-4a1a-bd78-75e46fa86be7 does not exist"
    }
  ]
}

Path parameters

Name Req/Opt Description
certificate_id required ID of certificate to revoke.

Request parameters

Name Req/Opt Type Description
reason required string Reason for revocation.
Allowed values: See Revocation reasons table below.
revocation_date optional string Specific day the certificate is considered revoked. Signing or other activities performed with the certificate before the revocation date are still considered valid.
Default: Certificate is revoked entirely from its validity start date.
comments optional string User-entered notes.

Revocation reasons

Revocation reason ID
unspecified
key_compromise
affiliation_changed
suspended
cessation_of_operation
certificate_hold
privilege_withdrawn
aa_compromise