Certificate Manager API, gRPC: CertificateService.Update
Updates the specified certificate.
gRPC request
rpc Update (UpdateCertificateRequest) returns (operation.Operation)
UpdateCertificateRequest
{
"certificate_id": "string",
"update_mask": "google.protobuf.FieldMask",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"certificate": "string",
"chain": "string",
"private_key": "string",
"deletion_protection": "bool"
}
|
Field |
Description |
|
certificate_id |
string Required field. ID of the certificate to update. |
|
update_mask |
Field mask that specifies which attributes of the certificate are going to be updated. |
|
name |
string New name for the certificate. |
|
description |
string New description for the certificate. |
|
labels |
object (map<string, string>) New labels for the certificate as |
|
certificate |
string New PEM-encoded certificate content for the certificate. Used only for imported certificates. |
|
chain |
string New PEM-encoded certificate chain content for the certificate. Used only for imported certificates. |
|
private_key |
string New PEM-encoded private key content for the certificate. Used only for imported certificates. |
|
deletion_protection |
bool Flag that protects deletion of the certificate |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"certificate_id": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"type": "CertificateType",
"domains": [
"string"
],
"status": "Status",
"issuer": "string",
"subject": "string",
"serial": "string",
"updated_at": "google.protobuf.Timestamp",
"issued_at": "google.protobuf.Timestamp",
"not_after": "google.protobuf.Timestamp",
"not_before": "google.protobuf.Timestamp",
"challenges": [
{
"domain": "string",
"type": "ChallengeType",
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
"status": "Status",
"message": "string",
"error": "string",
// Includes only one of the fields `dns_challenge`, `http_challenge`
"dns_challenge": {
"name": "string",
"type": "string",
"value": "string"
},
"http_challenge": {
"url": "string",
"content": "string"
}
// end of the list of possible fields
}
],
"deletion_protection": "bool",
"incomplete_chain": "bool"
}
// 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. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateCertificateMetadata
|
Field |
Description |
|
certificate_id |
string ID of the certificate being updated. |
Certificate
A certificate. For details about the concept, see documentation.
|
Field |
Description |
|
id |
string ID of the certificate. Generated at creation time. |
|
folder_id |
string ID of the folder that the certificate belongs to. |
|
created_at |
Creation timestamp. |
|
name |
string Name of the certificate. |
|
description |
string Description of the certificate. |
|
labels |
object (map<string, string>) Certificate labels as |
|
type |
enum CertificateType Type of the certificate.
|
|
domains[] |
string Fully qualified domain names of the certificate. |
|
status |
enum Status Status of the certificate.
|
|
issuer |
string Distinguished Name of the certificate authority that issued the certificate. |
|
subject |
string Distinguished Name of the entity that is associated with the public key contained in the certificate. |
|
serial |
string Serial number of the certificate. |
|
updated_at |
Time when the certificate is updated. |
|
issued_at |
Time when the certificate is issued. |
|
not_after |
Time after which the certificate is not valid. |
|
not_before |
Time before which the certificate is not valid. |
|
challenges[] |
Domains validation challenges of the certificate. Used only for managed certificates. |
|
deletion_protection |
bool Flag that protects deletion of the certificate |
|
incomplete_chain |
bool Mark imported certificates without uploaded chain or with chain which not lead to root certificate |
Challenge
Domain validation challenge.
|
Field |
Description |
|
domain |
string Domain of the challenge. |
|
type |
enum ChallengeType Type of the challenge.
|
|
created_at |
Time when the challenge is created. |
|
updated_at |
Time when the challenge is updated. |
|
status |
enum Status Status of the challenge.
|
|
message |
string Description of the challenge. |
|
error |
string Error of the challenge. |
|
dns_challenge |
DNS-record. Includes only one of the fields Data of the challenge. |
|
http_challenge |
HTTP-file. Includes only one of the fields Data of the challenge. |
DnsRecord
|
Field |
Description |
|
name |
string Name of the DNS record. |
|
type |
string Type of the DNS-record. |
|
value |
string Value of the DNS-record. |
HttpFile
|
Field |
Description |
|
url |
string Location of the HTTP file. |
|
content |
string Content of the HTTP file. |