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

Метод list

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

HTTP-запрос

GET https://lockbox.api.cloud.yandex.net/lockbox/v1/secrets

Query-параметры

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

Ответ

HTTP Code: 200 - OK

{
  "secrets": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "kmsKeyId": "string",
      "status": "string",
      "currentVersion": {
        "id": "string",
        "secretId": "string",
        "createdAt": "string",
        "destroyAt": "string",
        "description": "string",
        "status": "string",
        "payloadEntryKeys": [
          "string"
        ]
      },
      "deletionProtection": true
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
secrets[] object

Секрет, который состоит из нескольких версий.
secrets[].
id		 string

Идентификатор секрета.
secrets[].
folderId		 string

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

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

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

Имя секрета.
secrets[].
description		 string

(опционально) Описание секрета.
secrets[].
labels		 object

Пользовательские метки для секрета в виде пар key:value. Максимум 64 на ключ.
secrets[].
kmsKeyId		 string

(опционально) Идентификатор пользовательского ключа KMS. Если пользовательский ключ не указан, для шифрования и расшифровки используется системный ключ.
secrets[].
status		 string

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

  • CREATING: Секрет создается.
  • ACTIVE: Секрет активен и к нему можно получить доступ.

Можно установить в INACTIVE с помощью метода deactivate.

  • INACTIVE: Секрет неактивен и не может быть использован.

Можно установить в ACTIVE с помощью метода activate.
secrets[].
currentVersion		 object

Текущая версия секрета.
secrets[].
currentVersion.
id		 string

Идентификатор версии.
secrets[].
currentVersion.
secretId		 string

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

Время создания версии ключа.

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

Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.

Строка в формате RFC3339.
secrets[].
currentVersion.
description		 string

(опционально) Описание версии.
secrets[].
currentVersion.
status		 string

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

  • ACTIVE: Секрет активен и к нему можно получить доступ.
  • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле destroyAt.
  • DESTROYED: Версия уничтожена и не может быть восстановлена.
secrets[].
currentVersion.
payloadEntryKeys[]		 string

Ключи содержимого версии.
secrets[].
deletionProtection		 boolean (boolean)

Флаг, запрещающий удаление секрета.
nextPageToken string

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