- tocdepth
2
Версии секретов
Подсказка
Актуальную спецификацию можно скачать
и использовать в привычном инструменте.
Набор методов для управления версиями секретов:
Метод API |
HTTP-метод |
Описание |
---|---|---|
Get secret version |
GET |
Возвращает список всех версий секрета |
Create |
POST |
Создает новую версию секрета |
Delete |
DELETE |
Удаляет версию секрета |
Get secret version/{id} |
GET |
Возвращает метаданные версии секрета |
Disable secret version |
PATCH |
Отключает версию секрета |
Enable secret version |
PATCH |
Включает версию секрета |
Get payload |
GET |
Возвращает значение версии секрета |
- GET /v1/secrets/{secretId}/versions
- Parameters
secretId (string) – Обязательное поле. Идентификатор секрета.
- Query Parameters
page.limit (integer) – обязательное поле. Максимальное количство записей в одном запросе. (Макс: 1000, по-умолчанию: 100).
page.offset (integer) – обязательное поле. Сдвиг записей.
- Status Codes
200 OK – A successful response.
- Response JSON Object
versions (array) – версии секрета.
versions[].createdAt (string) – дата создания версии секрета.
versions[].id (integer) – идентификатор версии секрета.
versions[].secretId (string) – идентификатор секрета.
versions[].state (string) – состояние версии секрета.
- POST /v1/secrets/{secretId}/versions
- Parameters
secretId (string) – обязательное поле. Идентификатор секрета.
- Request JSON Object
payload (object) – обязательное поле. Секретные данные.
payload.data (string) – секретные данные.
- Status Codes
200 OK – A successful response.
- Response JSON Object
createdAt (string) – дата создания версии секрета.
id (integer) – идентификатор версии секрета.
secretId (string) – идентификатор секрета.
state (string) – состояние версии секрета.
- GET /v1/secrets/{secretId}/versions/{secretVersionId}
- Parameters
secretId (string) – обязательное поле. Идентификатор секрета.
secretVersionId (string) – обязательное поле. Идентификатор версии секрета.
- Status Codes
200 OK – A successful response.
- Response JSON Object
createdAt (string) – дата создания версии секрета.
id (integer) – идентификатор версии секрета.
secretId (string) – идентификатор секрета.
state (string) – состояние версии секрета.
- DELETE /v1/secrets/{secretId}/versions/{secretVersionId}
- Parameters
secretId (string) – обязательное поле. Идентификатор секрета.
secretVersionId (string) – обязательное поле. Идентификатор версии секрета.
- Status Codes
200 OK – A successful response.
- Response JSON Object
createdAt (string) – дата создания версии секрета.
id (integer) – идентификатор версии секрета.
secretId (string) – идентификатор секрета.
state (string) – состояние версии секрета.
- PATCH /v1/secrets/{secretId}/versions/{secretVersionId}/disable
- Parameters
secretId (string) – обязательное поле. Идентификатор секрета.
secretVersionId (string) – обязательное поле. Идентификатор версии секрета.
- Status Codes
200 OK – A successful response.
- Response JSON Object
createdAt (string) – дата создания версии секрета.
id (integer) – идентификатор версии секрета.
secretId (string) – идентификатор секрета.
state (string) – состояние версии секрета.
- PATCH /v1/secrets/{secretId}/versions/{secretVersionId}/enable
- Parameters
secretId (string) – обязательное поле. Идентификатор секрета.
secretVersionId (string) – обязательное поле. Идентификатор версии секрета.
- Status Codes
200 OK – A successful response.
- Response JSON Object
createdAt (string) – дата создания версии секрета.
id (integer) – идентификатор версии секрета.
secretId (string) – идентификатор секрета.
state (string) – состояние версии секрета.
- GET /v1/secrets/{secretId}/versions/{secretVersionId}/payload
- Parameters
secretId (string) – обязательное поле. Идентификатор секрета.
secretVersionId (string) – обязательное поле. Идентификатор версии секрета.
- Status Codes
200 OK – A successful response.
- Response JSON Object
data (string) – секретные данные.
Была ли статья полезной?
для Dev & Test