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

Метод create

Создает секрет в указанном каталоге.

HTTP-запрос

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

Параметры в теле запроса

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "kmsKeyId": "string",
  "versionDescription": "string",
  "versionPayloadEntries": [
    {
      "key": "string",

      // `versionPayloadEntries[]` включает только одно из полей `textValue`, `binaryValue`
      "textValue": "string",
      "binaryValue": "string",
      // конец списка возможных полей`versionPayloadEntries[]`

    }
  ],
  "deletionProtection": true
}
Поле Описание
folderId string

Обязательное поле. Идентификатор каталога, в котором создается секрет.

Максимальная длина строки в символах — 50.
name string

Имя секрета.

Максимальная длина строки в символах — 100.
description string

Описание секрета.

Максимальная длина строки в символах — 1024.
labels object

Пользовательские метки для секрета в виде пар key:value. Максимум 64 на ключ. Например, "project": "mvp" или "source": "dictionary".

Не более 64 на ресурс. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*.
kmsKeyId string

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

Максимальная длина строки в символах — 50.
versionDescription string

Описание первой версии.

Максимальная длина строки в символах — 256.
versionPayloadEntries[] object

Содержимое первой версии секрета.

Максимальное количество элементов — 32.
versionPayloadEntries[].
key		 string

Обязательное поле. Неконфиденциальный ключ содержимого версии.

Максимальная длина строки в символах — 256. Значение должно соответствовать регулярному выражению [.-_0-9a-zA-Z]+.
versionPayloadEntries[].
textValue		 string
versionPayloadEntries[] включает только одно из полей textValue, binaryValue

Используйте это поле для задания текстового значения.

Максимальная длина строки в символах — 65536.
versionPayloadEntries[].
binaryValue		 string (byte)
versionPayloadEntries[] включает только одно из полей textValue, binaryValue

Используйте это поле для установки двоичного значения.

Максимальная длина строки в символах — 65536.
deletionProtection boolean (boolean)

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

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.

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

Идентификатор операции.
description string

Описание операции. Длина описания должна быть от 0 до 256 символов.
createdAt string (date-time)

Время создания ресурса в формате в RFC3339.

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

Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modifiedAt string (date-time)

Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

Строка в формате RFC3339.
done boolean (boolean)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
error object
Описание ошибки в случае сбоя или отмены операции.
включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.
error.
code		 integer (int32)

Код ошибки. Значение из списка google.rpc.Code.
error.
message		 string

Текст ошибки.
error.
details[]		 object

Список сообщений с подробными сведениями об ошибке.
response object
включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.
В этой статье: