[Документация Yandex Cloud](../../../index.md) > [Yandex Key Management Service](../../index.md) > Справочник API > [REST (англ.)](../index.md) > [SymmetricKey](index.md) > List # Key Management Service API, REST: SymmetricKey.List Returns the list of symmetric KMS keys in the specified folder. ## HTTP request ``` GET https://cpl.kms.api.yandexcloud.kz/kms/v1/keys ``` ## Query parameters {#yandex.cloud.kms.v1.ListSymmetricKeysRequest} #| ||Field | Description || || folderId | **string** Required field. ID of the folder to list symmetric KMS keys in. The maximum string length in characters is 50. || || pageSize | **string** (int64) The maximum number of results per page to return. If the number of available results is larger than `pageSize`, the service returns a [ListSymmetricKeysResponse.nextPageToken](#yandex.cloud.kms.v1.ListSymmetricKeysResponse) that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. || || pageToken | **string** Page token. To get the next page of results, set `pageToken` to the [ListSymmetricKeysResponse.nextPageToken](#yandex.cloud.kms.v1.ListSymmetricKeysResponse) returned by a previous list request. The maximum string length in characters is 100. || |# ## Response {#yandex.cloud.kms.v1.ListSymmetricKeysResponse} **HTTP Code: 200 - OK** ```json { "keys": [ { "id": "string", "folderId": "string", "createdAt": "string", "name": "string", "description": "string", "labels": "object", "status": "string", "primaryVersion": { "id": "string", "keyId": "string", "status": "string", "algorithm": "string", "createdAt": "string", "primary": "boolean", "destroyAt": "string", "hostedByHsm": "boolean" }, "defaultAlgorithm": "string", "rotatedAt": "string", "rotationPeriod": "string", "deletionProtection": "boolean" } ], "nextPageToken": "string" } ``` #| ||Field | Description || || keys[] | **[SymmetricKey](#yandex.cloud.kms.v1.SymmetricKey)** List of symmetric 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 of results is greater than the specified [ListSymmetricKeysRequest.pageSize](#yandex.cloud.kms.v1.ListSymmetricKeysRequest), use the `nextPageToken` as the value for the [ListSymmetricKeysRequest.pageToken](#yandex.cloud.kms.v1.ListSymmetricKeysRequest) query parameter in the next list request. Each subsequent list request will have its own `nextPageToken` to continue paging through the results. || |# ## SymmetricKey {#yandex.cloud.kms.v1.SymmetricKey} A symmetric 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](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || name | **string** Name of the key. || || description | **string** Description of the key. || || labels | **object** (map<**string**, **string**>) Custom labels for the key as `key:value` pairs. Maximum 64 per key. || || status | **enum** (Status) Current status of the key. - `CREATING`: The key is being created. - `ACTIVE`: The key is active and can be used for encryption and decryption. Can be set to INACTIVE using the [SymmetricKeyService.Update](update.md#Update) method. - `INACTIVE`: The key is inactive and unusable. Can be set to ACTIVE using the [SymmetricKeyService.Update](update.md#Update) method. || || primaryVersion | **[SymmetricKeyVersion](#yandex.cloud.kms.v1.SymmetricKeyVersion)** Primary version of the key, used as the default for all encrypt/decrypt operations, when no version ID is specified. || || defaultAlgorithm | **enum** (SymmetricAlgorithm) Default encryption algorithm to be used with new versions of the key. - `AES_128`: AES algorithm with 128-bit keys. - `AES_192`: AES algorithm with 192-bit keys. - `AES_256`: AES algorithm with 256-bit keys. - `AES_256_HSM`: AES algorithm with 256-bit keys hosted by HSM - `GOST_R_3412_2015_K`: GOST R 34.12-2015 Kuznyechik algorithm || || rotatedAt | **string** (date-time) Time of the last key rotation (time when the last version was created). Empty if the key does not have versions yet. String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || rotationPeriod | **string** (duration) Time period between automatic key rotations. || || deletionProtection | **boolean** Flag that inhibits deletion of the key || |# ## SymmetricKeyVersion {#yandex.cloud.kms.v1.SymmetricKeyVersion} Symmetric KMS key version: metadata about actual cryptographic data. #| ||Field | Description || || id | **string** ID of the key version. || || keyId | **string** ID of the symmetric KMS key that the version belongs to. || || status | **enum** (Status) Status of the key version. - `ACTIVE`: The version is active and can be used for encryption and decryption. - `SCHEDULED_FOR_DESTRUCTION`: The version is scheduled for destruction, the time when it will be destroyed is specified in the `SymmetricKeyVersion.destroyAt` field. - `DESTROYED`: The version is destroyed and cannot be recovered. || || algorithm | **enum** (SymmetricAlgorithm) Encryption algorithm that should be used when using the key version to encrypt plaintext. - `AES_128`: AES algorithm with 128-bit keys. - `AES_192`: AES algorithm with 192-bit keys. - `AES_256`: AES algorithm with 256-bit keys. - `AES_256_HSM`: AES algorithm with 256-bit keys hosted by HSM - `GOST_R_3412_2015_K`: GOST R 34.12-2015 Kuznyechik algorithm || || createdAt | **string** (date-time) Time when the key version was created. String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || primary | **boolean** Indication of a primary version, that is to be used by default for all cryptographic operations that don't have a key version explicitly specified. || || destroyAt | **string** (date-time) Time when the key version is going to be destroyed. Empty unless the status is `SCHEDULED_FOR_DESTRUCTION`. String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || hostedByHsm | **boolean** Indication of the version that is hosted by HSM. || |#