Method: projects.locations.certificateAuthorities.certificates.revoke
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://privateca.googleapis.com/v1beta1/{name=projects/*/locations/*/certificateAuthorities/*/certificates/*}:revoke
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. The resource name for this Certificate in the format projects/*/locations/*/certificateAuthorities/*/certificates/* .
Authorization requires the following IAM permission on the specified resource name :
privateca.certificates.update
|
Request body
The request body contains data with the following structure:
Fields |
reason |
enum (RevocationReason )
Required. The RevocationReason for revoking this certificate.
|
requestId |
string
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
Response body
If successful, the response body contains an instance of Certificate
.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-30 UTC."],[[["\u003cp\u003eThis webpage describes how to revoke a Certificate using an HTTP POST request to a specific URL endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL requires a \u003ccode\u003ename\u003c/code\u003e path parameter, which represents the resource name of the Certificate to be revoked in a specific format and also requires a specific IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must include a \u003ccode\u003ereason\u003c/code\u003e for the revocation, which is a required enumerated value, and can optionally include a \u003ccode\u003erequestId\u003c/code\u003e for request identification purposes.\u003c/p\u003e\n"],["\u003cp\u003eA successful request will return an instance of the revoked Certificate as the response body.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to perform this operation requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,[]]