tocdepth: 2

Секреты

Подсказка

Актуальную спецификацию можно скачать и использовать в привычном инструменте.

Набор методов для управления секретами:

Метод API	HTTP-метод	Описание
Get secret	GET	Возвращает список секретов
Get secret/{id}	GET	Возвращает информацию об указанном секрете
Create	POST	Создает секрет
Update	PATCH	Обновляет метаданные секрета
Delete	DELETE	Удаляет секрет

GET /v1/secrets

Query Parameters

parentId (string) – обязательное поле. Идентификатор родительского сервис инстанса.
page.limit (integer) – обязательное поле. Максимальное кол-во записей в одном запросе. (Макс: 1000, по-умолчанию: 100).
page.offset (integer) – обязательное поле. Сдвиг записей.

Status Codes

200 OK – A successful response.

Response JSON Object

secrets (array) – секреты.
secrets[].createdAt (string) – дата создания секрета.
secrets[].description (string) – описание секрета.
secrets[].id (string) – идентификатор секрета.
secrets[].kmsKeyId (string) – идентификатор ключа шифрования.
secrets[].labels (object) – метки секрета.
secrets[].name (string) – наименование секрета.
secrets[].owner (string) – идентификатор владельца секрета.

POST /v1/secrets

Request JSON Object

description (string) – описание секрета.
kmsKeyId (string) – идентификатор ключа шифрования.
labels (object) – метки секрета.
name (string) – наименование секрета.
parentId (string) – обязательное поле. Идентификатор родительского сервис инстанса.
payload (object) – обязательное поле. Секретные данные.
payload.data (string) – секретные данные.

Status Codes

200 OK – A successful response.

Response JSON Object

createdAt (string) – дата создания секрета.
description (string) – описание секрета.
id (string) – идентификатор секрета.
kmsKeyId (string) – идентификатор ключа шифрования.
labels (object) – метки секрета.
name (string) – наименование секрета.
owner (string) – идентификатор владельца секрета.

PATCH /v1/secrets/{secret.id}

Parameters

secret.id (string) – идентификатор секрета.

Query Parameters

updateMask (string) – обязательное поле. Маска обновления ключа.

Request JSON Object

createdAt (string) – дата создания секрета.
description (string) – описание секрета.
id (string) – идентификатор секрета.
kmsKeyId (string) – идентификатор ключа шифрования.
labels (object) – метки секрета.
name (string) – наименование секрета.
owner (string) – идентификатор владельца секрета.

Status Codes

200 OK – A successful response.

Response JSON Object

createdAt (string) – дата создания секрета.
description (string) – описание секрета.
id (string) – идентификатор секрета.
kmsKeyId (string) – идентификатор ключа шифрования.
labels (object) – метки секрета.
name (string) – наименование секрета.
owner (string) – идентификатор владельца секрета.

GET /v1/secrets/{secretId}

Parameters

secretId (string) – обязательное поле. Идентификатор секрета.

Status Codes

200 OK – A successful response.

Response JSON Object

createdAt (string) – дата создания секрета.
description (string) – описание секрета.
id (string) – идентификатор секрета.
kmsKeyId (string) – идентификатор ключа шифрования.
labels (object) – метки секрета.
name (string) – наименование секрета.
owner (string) – идентификатор владельца секрета.

DELETE /v1/secrets/{secretId}

Parameters

secretId (string) – обязательное поле. Идентификатор секрета.

Status Codes

200 OK – A successful response.

Была ли статья полезной?