Версия ключа

Совет

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

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

Метод API

HTTP-метод

Описание

Get

GET {keyId}/version

Возвращает список всех версий ключа

Get

GET {keyId}/versions/{keyVersionId}

Возвращает информацию про определенную версию ключа

Create

POST {keyId}/versions

Создает новую версию ключа

Create

POST {keyVersionId}/restore

Восстанавливает версию ключа

Create

POST {keyVersionId}/disable

Деактивирует версию ключа

Create

POST {keyVersionId}/enable

Активирует версию ключа

Update

PATCH

Устанавливает первичную версию для указанного ключа

Delete

DELETE

Удаляет версию ключа

GET /v1/keys/{keyId}/versions
Parameters
  • keyId (string) – обязательное поле. Индентификатор криптографического ключа.

Query Parameters
  • page.limit (integer) – обязательное поле. Максимальное кол-во записей в одном запросе. (Макс: 1000, по умолчанию: 100).

  • page.offset (integer) – обязательное поле. Сдвиг записей.

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • versions[].algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.

  • versions[].createdAt (string) – дата создания версии криптографического ключа.

  • versions[].destroyAt (string) – дата удаления версии криптографического ключа.

  • versions[].id (integer) – идентификатор версии криптографического ключа.

  • versions[].keyId (string) – идентификатор криптографического ключа.

  • versions[].state (string) – состояние версии криптографического ключа.

POST /v1/keys/{keyId}/versions
Parameters
  • keyId (string) – обязательное поле. Идентификатор криптографического ключа.

Request JSON Object
  • algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.

  • createdAt (string) – дата создания версии криптографического ключа.

  • destroyAt (string) – дата удаления версии криптографического ключа.

  • id (integer) – идентификатор версии криптографического ключа.

  • keyId (string) – идентификатор криптографического ключа.

  • state (string) – состояние версии криптографического ключа.

GET /v1/keys/{keyId}/versions/{keyVersionId}
Parameters
  • keyId (string) – обязательное поле. Идентификатор криптографического ключа.

  • keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.

  • createdAt (string) – дата создания версии криптографического ключа.

  • destroyAt (string) – дата удаления версии криптографического ключа.

  • id (integer) – идентификатор версии криптографического ключа.

  • keyId (string) – идентификатор криптографического ключа.

  • state (string) – состояние версии криптографического ключа.

DELETE /v1/keys/{keyId}/versions/{keyVersionId}
Parameters
  • keyId (string) – обязательное поле. Идентификатор криптографического ключа.

  • keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.

  • createdAt (string) – дата создания версии криптографического ключа.

  • destroyAt (string) – дата удаления версии криптографического ключа.

  • id (integer) – идентификатор версии криптографического ключа.

  • keyId (string) – идентификатор криптографического ключа.

  • state (string) – состояние версии криптографического ключа.

POST /v1/keys/{keyId}/versions/{keyVersionId}/disable
Parameters
  • keyId (string) – обязательное поле. Идентификатор криптографического ключа.

  • keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.

  • createdAt (string) – дата создания версии криптографического ключа.

  • destroyAt (string) – дата удаления версии криптографического ключа.

  • id (integer) – идентификатор версии криптографического ключа.

  • keyId (string) – идентификатор криптографического ключа.

  • state (string) – состояние версии криптографического ключа.

POST /v1/keys/{keyId}/versions/{keyVersionId}/enable
Parameters
  • keyId (string) – обязательное поле. Идентификатор криптографического ключа.

  • keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.

  • createdAt (string) – дата создания версии криптографического ключа.

  • destroyAt (string) – дата удаления версии криптографического ключа.

  • id (integer) – идентификатор версии криптографического ключа.

  • keyId (string) – идентификатор криптографического ключа.

  • state (string) – состояние версии криптографического ключа.

PATCH /v1/keys/{keyId}/versions/{keyVersionId}/primary
Parameters
  • keyId (string) – обязательное поле. Идентификатор криптографического ключа.

  • keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • createdAt (string) – дата создания ключа.

  • defaultAlgorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.

  • description (string) – описание криптографического ключа.

  • id (string) – идентификатор криптографического ключа.

  • labels[] (string) – ярлык криптографического ключа.

  • name (string) – наименование криптографического ключа.

  • nextRotationTime (string) – следующая дата ротации ключа.

  • owner (string) – идентификатор владельца ключа.

  • primary.algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.

  • primary.createdAt (string) – дата создания версии криптографического ключа.

  • primary.destroyAt (string) – дата удаления версии криптографического ключа.

  • primary.id (integer) – идентификатор версии криптографического ключа.

  • primary.keyId (string) – идентификатор криптографического ключа.

  • primary.state (string) – состояние версии криптографического ключа.

  • rotationPeriod (string) – период ротации ключа.

POST /v1/keys/{keyId}/versions/{keyVersionId}/restore
Parameters
  • keyId (string) – обязательное поле. Идентификатор криптографического ключа.

  • keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.

  • createdAt (string) – дата создания версии криптографического ключа.

  • destroyAt (string) – дата удаления версии криптографического ключа.

  • id (integer) – идентификатор версии криптографического ключа.

  • keyId (string) – идентификатор криптографического ключа.

  • state (string) – состояние версии криптографического ключа.