Certificate Manager API, gRPC: CertificateService.List

Written by

Yandex Cloud

Updated at December 17, 2024

gRPC request
ListCertificatesRequest
ListCertificatesResponse
Certificate
Challenge
DnsRecord
HttpFile

Returns the list of certificates in the specified folder.

gRPC request

rpc List (ListCertificatesRequest) returns (ListCertificatesResponse)

ListCertificatesRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "view": "CertificateView"
}

Field	Description
folder_id	string Required field. ID of the folder to list certificate in.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a ListCertificatesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.
page_token	string Page token. To get the next page of results, set `page_token` to the ListCertificatesResponse.next_page_token returned by a previous list request.
view	enum CertificateView The output type of the certificate. `BASIC`: Output basic information about the certificate. `FULL`: Output full information about the certificate including domain challenges.

ListCertificatesResponse

{
  "certificates": [
    {
      "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"
    }
  ],
  "next_page_token": "string"
}

Field

Description

certificates[]

Certificate

List of certificates in the specified folder.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number
of results is greater than the specified ListCertificatesRequest.page_size, use
the next_page_token as the value for the ListCertificatesRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

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	google.protobuf.Timestamp Creation timestamp.
name	string Name of the certificate. The name is unique within the folder.
description	string Description of the certificate.
labels	object (map<string, 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.
updated_at	google.protobuf.Timestamp Time when the certificate is updated.
issued_at	google.protobuf.Timestamp Time when the certificate is issued.
not_after	google.protobuf.Timestamp Time after which the certificate is not valid.
not_before	google.protobuf.Timestamp Time before which the certificate is not valid.
challenges[]	Challenge 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. `CHALLENGE_TYPE_UNSPECIFIED` `DNS`: Domain validation type that using DNS-records. `HTTP`: Domain validation type that using HTTP-files.
created_at	google.protobuf.Timestamp Time when the challenge is created.
updated_at	google.protobuf.Timestamp Time when the challenge is updated.
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.
dns_challenge	DnsRecord DNS-record. Includes only one of the fields `dns_challenge`, `http_challenge`. Data of the challenge.
http_challenge	HttpFile HTTP-file. Includes only one of the fields `dns_challenge`, `http_challenge`. 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, gRPC: CertificateService.List

gRPC request

ListCertificatesRequest

ListCertificatesResponse

Certificate

Challenge

DnsRecord

HttpFile

Was the article helpful?