Method: projects.locations.caPools.certificates.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://privateca.googleapis.com/v1/{certificate.name=projects/*/locations/*/caPools/*/certificates/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
certificate.name |
string
Identifier. The resource name for this Certificate in the format projects/*/locations/*/caPools/*/certificates/*.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Required. A list of fields to be updated in this request. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
|
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 the 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).
|
Request body
The request body contains an instance of Certificate.
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 details how to update a Certificate, with the only currently updatable field being the labels field.\u003c/p\u003e\n"],["\u003cp\u003eThe update operation uses a PATCH request to a specific URL following gRPC Transcoding syntax, including placeholders for project, location, CA pool, and certificate identifiers.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eupdateMask\u003c/code\u003e query parameter, formatted as a FieldMask, is required to specify which fields should be updated.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003erequestId\u003c/code\u003e query parameter is available for request idempotency, allowing clients to safely retry requests without creating duplicates.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests return a response body containing an instance of the updated Certificate, while the request body contains the Certificate instance to update.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.caPools.certificates.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nUpdate a [Certificate](/certificate-authority-service/docs/reference/rest/v1/projects.locations.caPools.certificates#Certificate). Currently, the only field you can update is the [labels](/certificate-authority-service/docs/reference/rest/v1/projects.locations.caPools.certificates#Certificate.FIELDS.labels) field.\n\n### HTTP request\n\n`PATCH https://privateca.googleapis.com/v1/{certificate.name=projects/*/locations/*/caPools/*/certificates/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Certificate](/certificate-authority-service/docs/reference/rest/v1/projects.locations.caPools.certificates#Certificate).\n\n### Response body\n\nIf successful, the response body contains an instance of [Certificate](/certificate-authority-service/docs/reference/rest/v1/projects.locations.caPools.certificates#Certificate).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
