Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Certificate Manager Private CA API, REST: PrivateCaCertificate.RevokeCertificate

Written by
Updated at December 17, 2024

Revokes a previously issued certificate. Revoked certificates are added to the CA's CRL or OCSP if enabled.

HTTP request

POST https://private-ca.certificate-manager.api.cloud.yandex.net/privateca/v1/privateCertificates/{certificateId}:revoke

Path parameters

Request to revoke an issued certificate, making it invalid.

Field

Description

certificateId

string

Required field. The ID of the certificate to revoke.

Body parameters

{
  "crlReason": "string"
}

Request to revoke an issued certificate, making it invalid.

Field

Description

crlReason

enum (CrlReason)

Required field. The reason for revoking the certificate (must be one of the reasons defined above).

  • CRL_REASON_UNSPECIFIED
  • KEY_COMPROMISE: Key used in the certificate has been compromised.
  • CA_COMPROMISE: The Certificate Authority (CA) has been compromised.
  • AFFILIATION_CHANGED: Change in affiliation, such as an organization restructure.
  • SUPERSEDED: Certificate superseded by a newer one.
  • CESSATION_OF_OPERATION: Operations relying on this certificate have ceased.
  • CERTIFICATE_HOLD: Temporarily hold the certificate. Can be restored later.
  • REMOVE_FROM_CRL: The certificate was removed from the Certificate Revocation List (CRL).
  • PRIVILEGE_WITHDRAWN: Privileges associated with the certificate were withdrawn.
  • AA_COMPROMISE: Certificate Authority or administrative compromise.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "certificateAuthorityId": "string",
    "certificateId": "string"
  },
  // Includes only one of the fields `error`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

RevokeCertificateMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

RevokeCertificateMetadata

Metadata for the RevokeCertificate operation.

Field

Description

certificateAuthorityId

string

Required field. The ID of the Certificate Authority that issued the revoked certificate.

certificateId

string

Required field. The ID of the certificate that was revoked.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.
Previous
List
Next
ListAccessBindings