Подключиться
Yandex Certificate Manager

Метод list

Возвращает список сертификатов в указанном каталоге.

HTTP-запрос

GET https://certificate-manager.api.cloud.yandex.net/certificate-manager/v1/certificates

Query-параметры

Параметр Описание
folderId Обязательное поле. Идентификатор каталога для получения списка сертификатов. Максимальная длина строки в символах — 50.
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение page_token равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
view Тип вывода сертификата.
  • BASIC: Вывод основной информации о сертификате.
  • FULL: Вывод полной информации о сертификате, включающей данные для прохождения процедуры проверки прав владения доменом.

Ответ

HTTP Code: 200 - OK

{
  "certificates": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "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",

          // `certificates[].challenges[]` включает только одно из полей `dnsChallenge`, `httpChallenge`
          "dnsChallenge": {
            "name": "string",
            "type": "string",
            "value": "string"
          },
          "httpChallenge": {
            "url": "string",
            "content": "string"
          },
          // конец списка возможных полей`certificates[].challenges[]`

        }
      ]
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
certificates[] object

Сертификат. Подробнее об этом читайте в документации.
certificates[].
id		 string

Идентификатор сертификата. Генерируется при создании.
certificates[].
folderId		 string

Идентификатор каталога, которому принадлежит сертификат.
certificates[].
createdAt		 string (date-time)

Время создания ресурса.

Строка в формате RFC3339.
certificates[].
name		 string

Имя сертификата. Имя должно быть уникальным в каталоге.
certificates[].
description		 string

Описание сертификата.
certificates[].
labels		 object

Метки ресурса в формате ключ:значение.
certificates[].
type		 string

Тип сертификата.

Поддерживаемые типы сертификатов.

  • IMPORTED: Сертификат импортирован пользователем.
  • MANAGED: Сертификат создан сервисом.
certificates[].
domains[]		 string

Полные доменные имена сертификата.
certificates[].
status		 string

Статус сертификата.

  • VALIDATING: Требуется проверка доменов сертификатов. Используется только для сертификатов от Let's Encrypt®.
  • INVALID: Выдача сертификата не удалась. Используется только для сертификатов от Let's Encrypt®.
  • ISSUED: Сертификат выдан.
  • REVOKED: Сертификат отозван или аннулирован.
  • RENEWING: Сертификат обновляется. Используется только для сертификатов от Let's Encrypt®.
  • RENEWAL_FAILED: Обновление сертификата не удалось. Используется только для сертификатов от Let's Encrypt®.
certificates[].
issuer		 string

Уникальное имя Distinguished Name центра сертификации, выпустившего сертификат.
certificates[].
subject		 string

Уникальное имя Distinguished Name сущности, связанной с открытым ключом, содержащимся в сертификате.
certificates[].
serial		 string

Серийный номер сертификата.
certificates[].
updatedAt		 string (date-time)

Время последнего изменения сертификата.

Строка в формате RFC3339.
certificates[].
issuedAt		 string (date-time)

Время выдачи сертификата.

Строка в формате RFC3339.
certificates[].
notAfter		 string (date-time)

Время, по истечении которого сертификат считается недействительным.

Строка в формате RFC3339.
certificates[].
notBefore		 string (date-time)

Время, после наступления которого сертификат считается действительным.

Строка в формате RFC3339.
certificates[].
challenges[]		 object

Процедура проверки домена.
certificates[].
challenges[].
domain		 string

Домен, права на владение которым проверяются.
certificates[].
challenges[].
type		 string
Тип процедуры проверки.

Поддерживаемые типы проверки домена.

  • DNS: Тип проверки домена, использующий DNS-записи.
  • HTTP: Тип проверки домена, использующий HTTP-файлы.
certificates[].
challenges[].
createdAt		 string (date-time)

Время, когда была начата процедура проверки.

Строка в формате RFC3339.
certificates[].
challenges[].
updatedAt		 string (date-time)

Время последней проверки.

Строка в формате RFC3339.
certificates[].
challenges[].
status		 string
Статус процедуры проверки.
  • PENDING: Процедура проверки ждет, пока пользователь выполнит действия, необходимые для прохождения проверки.
  • PROCESSING: Процедура проверки ожидает одобрения от Let's Encrypt®.
  • VALID: Процедура проверки пройдена.
  • INVALID: Проверка прав для определенного домена завершилась неудачно или истек недельный период, выделенный для проверки.
certificates[].
challenges[].
message		 string

Описание процедуры проверки.
certificates[].
challenges[].
error		 string

Ошибка процедуры проверки.
certificates[].
challenges[].
dnsChallenge		 object
DNS-запись.
certificates[].challenges[] включает только одно из полей dnsChallenge, httpChallenge
certificates[].
challenges[].
dnsChallenge.
name		 string

Имя DNS-записи.
certificates[].
challenges[].
dnsChallenge.
type		 string

Тип DNS-записи.
certificates[].
challenges[].
dnsChallenge.
value		 string

Значение DNS-записи.
certificates[].
challenges[].
httpChallenge		 object
HTTP-файл.
certificates[].challenges[] включает только одно из полей dnsChallenge, httpChallenge
certificates[].
challenges[].
httpChallenge.
url		 string

Расположение HTTP-файла.
certificates[].
challenges[].
httpChallenge.
content		 string

Содержимое HTTP-файла.
nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте next_page_token в качестве значения параметра pageToken в следующем запросе списка ресурсов. Каждый следующий запрос списка будет иметь свой nextPageToken для продолжения перебора страниц результатов.
В этой статье: