Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Lockbox
  • Начало работы
  • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • PayloadService
      • SecretService
      • OperationService
    • REST
      • Обзор
      • Payload
        • Обзор
        • get
      • Secret
        • Обзор
        • activate
        • addVersion
        • cancelVersionDestruction
        • create
        • deactivate
        • delete
        • get
        • list
        • listAccessBindings
        • listOperations
        • listVersions
        • scheduleVersionDestruction
        • setAccessBindings
        • update
        • updateAccessBindings
  1. Справочник API
  2. REST
  3. Secret
  4. get

Метод get

  • HTTP-запрос
  • Path-параметры
  • Ответ

Возвращает указанный секрет.

Чтобы получить список доступных секретов, выполните запрос list. Чтобы получить содержимое версии, используйте запрос get.

HTTP-запрос

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

Path-параметры

Параметр Описание
secretId Обязательное поле. Идентификатор возвращаемого секрета. Чтобы получить идентификатор секрета, выполните запрос [List]. Максимальная длина строки в символах — 50.

Ответ

HTTP Code: 200 - OK

{
  "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
}

Секрет, который состоит из нескольких версий.

Поле Описание
id string

Идентификатор секрета.

folderId string

Идентификатор каталога, которому принадлежит секрет.

createdAt string (date-time)

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

Строка в формате RFC3339.

name string

Имя секрета.

description string

(опционально) Описание секрета.

labels object

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

kmsKeyId string

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

status string

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

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

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

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

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

currentVersion object

Текущая версия секрета.

currentVersion.
id
string

Идентификатор версии.

currentVersion.
secretId
string

Идентификатор секрета, которому принадлежит версия.

currentVersion.
createdAt
string (date-time)

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

Строка в формате RFC3339.

currentVersion.
destroyAt
string (date-time)

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

Строка в формате RFC3339.

currentVersion.
description
string

(опционально) Описание версии.

currentVersion.
status
string

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

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

Ключи содержимого версии.

deletionProtection boolean (boolean)

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

В этой статье:
  • HTTP-запрос
  • Path-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»