Версии секретов

Подсказка

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

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

Метод 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

Возвращает значение версии секрета

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) – состояние версии секрета.

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

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

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • createdAt (string) – дата создания версии секрета.

  • id (integer) – идентификатор версии секрета.

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

  • state (string) – состояние версии секрета.

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) – состояние версии секрета.

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

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

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • data (string) – секретные данные.

Evolution