Key Management Service API, REST: AsymmetricEncryptionKey.List
Returns the list of asymmetric KMS keys in the specified folder.
HTTP request
GET https://kms.api.cloud.yandex.net/kms/v1/asymmetricEncryptionKeys
Query parameters
Field |
Description |
folderId |
string Required field. ID of the folder to list asymmetric KMS keys in. |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
Response
HTTP Code: 200 - OK
{
"keys": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"status": "string",
"encryptionAlgorithm": "string",
"deletionProtection": "boolean"
}
],
"nextPageToken": "string"
}
Field |
Description |
keys[] |
List of asymmetric KMS keys in the specified folder. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number |
AsymmetricEncryptionKey
An asymmetric KMS key that may contain several versions of the cryptographic material.
Field |
Description |
id |
string ID of the key. |
folderId |
string ID of the folder that the key belongs to. |
createdAt |
string (date-time) Time when the key was created. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the key. |
description |
string Description of the key. |
labels |
string Custom labels for the key as |
status |
enum (Status) Current status of the key.
|
encryptionAlgorithm |
enum (AsymmetricEncryptionAlgorithm) Asymmetric Encryption Algorithm ID.
|
deletionProtection |
boolean Flag that inhibits deletion of the key |