Ключи

Совет

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

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

Метод API

HTTP-метод

Описание

Get keys

GET

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

Get keys/{keyId}

GET

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

Create

POST

Создает ключ

Update

PATCH

Обновляет параметры ключа

Delete

DELETE

Удаляет ключ

GET /v1/keys
Query Parameters
  • parentId (string) – обязательное поле. Идентификатор пространства имен.

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

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

Status Codes
  • 200 OK – A successful response.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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) – период ротации ключа.

PATCH /v1/keys/{key.id}
Parameters
  • key.id (string) – идентификатор криптографического ключа.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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) – период ротации ключа.

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

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) – период ротации ключа.

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

Status Codes
  • 200 OK – A successful response.