Certificate Manager API, REST: Certificate.Update

Written by

Updated at October 17, 2024

HTTP request
Path parameters
Body parameters
Response
UpdateCertificateMetadata
Status
Certificate
Challenge
DnsRecord
HttpFile

Updates the specified certificate.

HTTP request

PATCH https://certificate-manager.api.cloud.yandex.net/certificate-manager/v1/certificates/{certificateId}

Path parameters

Field

Description

certificateId

string

Required field. ID of the certificate to update.
To get the ID of a certificate use a CertificateService.List request.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "certificate": "string",
  "chain": "string",
  "privateKey": "string",
  "deletionProtection": "boolean"
}

Field	Description
updateMask	string (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string New name for the certificate.
description	string New description for the certificate.
labels	string New labels for the certificate as `key:value` pairs.
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.
privateKey	string New PEM-encoded private key content for the certificate. Used only for imported certificates.
deletionProtection	boolean Flag that protects deletion of the certificate

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "certificateId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "string",
    "type": "string",
    "domains": [
      "string"
    ],
    "status": "string",
    "issuer": "string",
    "subject": "string",
    "serial": "string",
    "updatedAt": "string",
    "issuedAt": "string",
    "notAfter": "string",
    "notBefore": "string",
    "challenges": [
      {
        "domain": "string",
        "type": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "status": "string",
        "message": "string",
        "error": "string",
        // Includes only one of the fields `dnsChallenge`, `httpChallenge`
        "dnsChallenge": {
          "name": "string",
          "type": "string",
          "value": "string"
        },
        "httpChallenge": {
          "url": "string",
          "content": "string"
        }
        // end of the list of possible fields
      }
    ],
    "deletionProtection": "boolean",
    "incompleteChain": "boolean"
  }
  // 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	UpdateCertificateMetadata 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`, `response`. 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.
response	Certificate The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. 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.

UpdateCertificateMetadata

Field

Description

certificateId

string

ID of the certificate being updated.

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.

Certificate

A certificate. For details about the concept, see documentation.

Field	Description
id	string ID of the certificate. Generated at creation time.
folderId	string ID of the folder that the certificate belongs to.
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).
name	string Name of the certificate. The name is unique within the folder.
description	string Description of the certificate.
labels	string Certificate labels as `key:value` pairs.
type	enum (CertificateType) Type of the certificate. `CERTIFICATE_TYPE_UNSPECIFIED` `IMPORTED`: The certificate is imported by user. `MANAGED`: The certificate is created by service.
domains[]	string Fully qualified domain names of the certificate.
status	enum (Status) Status of the certificate. `STATUS_UNSPECIFIED` `VALIDATING`: The certificate domains validation are required. Used only for managed certificates. `INVALID`: The certificate issuance is failed. Used only for managed certificates. `ISSUED`: The certificate is issued. `REVOKED`: The certificate is revoked. `RENEWING`: The certificate renewal is started. Used only for managed certificates. `RENEWAL_FAILED`: The certificate renewal is failed. Used only for managed certificates.
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.
updatedAt	string (date-time) Time when the certificate is updated. 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).
issuedAt	string (date-time) Time when the certificate is issued. 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).
notAfter	string (date-time) Time after which the certificate is not valid. 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).
notBefore	string (date-time) Time before which the certificate is not valid. 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).
challenges[]	Challenge Domains validation challenges of the certificate. Used only for managed certificates.
deletionProtection	boolean Flag that protects deletion of the certificate
incompleteChain	boolean 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. `CHALLENGE_TYPE_UNSPECIFIED` `DNS`: Domain validation type that using DNS-records. `HTTP`: Domain validation type that using HTTP-files.
createdAt	string (date-time) Time when the challenge is created. 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).
updatedAt	string (date-time) Time when the challenge is updated. 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).
status	enum (Status) Status of the challenge. `STATUS_UNSPECIFIED` `PENDING`: The challenge is waiting to be completed. `PROCESSING`: The challenge is awaiting approval from Let's Encrypt. `VALID`: The challenge is complete. `INVALID`: The rights check for a specific domain failed or the one-week period allocated for the check expired.
message	string Description of the challenge.
error	string Error of the challenge.
dnsChallenge	DnsRecord DNS-record. Includes only one of the fields `dnsChallenge`, `httpChallenge`. Data of the challenge.
httpChallenge	HttpFile HTTP-file. Includes only one of the fields `dnsChallenge`, `httpChallenge`. 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.

Certificate Manager API, REST: Certificate.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

ResponseResponse

UpdateCertificateMetadataUpdateCertificateMetadata

StatusStatus

CertificateCertificate

ChallengeChallenge

DnsRecordDnsRecord

HttpFileHttpFile

Was the article helpful?

HTTP request

Path parameters

Body parameters

Response

UpdateCertificateMetadata

Status

Certificate

Challenge

DnsRecord

HttpFile