Версия ключа
Набор методов для управления версиями ключа:
Метод 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 |
Удаляет версию ключа |
keyId (string) – обязательное поле. Идентификатор криптографического ключа.
algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
200 OK – A successful response.
algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
createdAt (string) – дата создания версии криптографического ключа.
destroyAt (string) – дата удаления версии криптографического ключа.
id (integer) – идентификатор версии криптографического ключа.
keyId (string) – идентификатор криптографического ключа.
state (string) – состояние версии криптографического ключа.
keyId (string) – обязательное поле. Идентификатор криптографического ключа.
keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.
200 OK – A successful response.
algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
createdAt (string) – дата создания версии криптографического ключа.
destroyAt (string) – дата удаления версии криптографического ключа.
id (integer) – идентификатор версии криптографического ключа.
keyId (string) – идентификатор криптографического ключа.
state (string) – состояние версии криптографического ключа.
keyId (string) – обязательное поле. Идентификатор криптографического ключа.
keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.
200 OK – A successful response.
algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
createdAt (string) – дата создания версии криптографического ключа.
destroyAt (string) – дата удаления версии криптографического ключа.
id (integer) – идентификатор версии криптографического ключа.
keyId (string) – идентификатор криптографического ключа.
state (string) – состояние версии криптографического ключа.
keyId (string) – обязательное поле. Идентификатор криптографического ключа.
keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.
200 OK – A successful response.
algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
createdAt (string) – дата создания версии криптографического ключа.
destroyAt (string) – дата удаления версии криптографического ключа.
id (integer) – идентификатор версии криптографического ключа.
keyId (string) – идентификатор криптографического ключа.
state (string) – состояние версии криптографического ключа.
keyId (string) – обязательное поле. Идентификатор криптографического ключа.
keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.
200 OK – A successful response.
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 (array) – ярлык криптографического ключа.
labels[] (string) – ярлык криптографического ключа.
name (string) – наименование криптографического ключа.
nextRotationTime (string) – следующая дата ротации ключа.
owner (string) – идентификатор владельца ключа.
primary (object) – версии криптографического ключа.
primary.algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
primary.createdAt (string) – дата создания версии криптографического ключа.
primary.destroyAt (string) – дата удаления версии криптографического ключа.
primary.id (integer) – идентификатор версии криптографического ключа.
primary.keyId (string) – идентификатор криптографического ключа.
primary.state (string) – состояние версии криптографического ключа.
rotationPeriod (string) – период ротации ключа.
keyId (string) – обязательное поле. Идентификатор криптографического ключа.
keyVersionId (integer) – обязательное поле. Идентификатор версии криптографического ключа.
200 OK – A successful response.
algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
createdAt (string) – дата создания версии криптографического ключа.
destroyAt (string) – дата удаления версии криптографического ключа.
id (integer) – идентификатор версии криптографического ключа.
keyId (string) – идентификатор криптографического ключа.
state (string) – состояние версии криптографического ключа.