Fetching List of AWS Keys
Use the get /v1/cckm/aws/keys
API to view the list of the AWS keys. The results can be filtered using the query parameters.
Syntax
Request Parameter
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Request Query Parameters
Parameter | Type | Description |
---|---|---|
id | string | Internal ID of the AWS key. |
keyid | string | ID of the AWS key. |
arn | string | Amazon Resource Name (ARN) of the key. |
alias | string | Alias of the key. |
kms | string | Name of the AWS KMS. |
kms_id | string | ID of the AWS KMS. |
region | string | Region name. |
cloud_name | string | Cloud name. |
origin | string | Source of the AWS customer master key (CMK) key material. The key origin cannot be changed. The origin of the key can be: • AWS_KMS • EXTERNAL |
job_config_id | string | ID of the scheduler configuration job. |
cckm_policy_template_id | string | ID of the policy template applied to the key. |
enabled | boolean | Fetches the enabled keys. |
gone | boolean | Fetches keys based on their existence in the cloud. |
tags | string | Fetches the keys based on valid tag values. |
keystate | string | State of the AWS key. |
keyusage | string | Usage of the AWS key. |
rotation_job_enabled | boolean | Fetches the key based on the rotation job status. |
CustomerMasterKeySpec | string | Fetches keys based on CustomerMasterKeySpec. |
key_material_origin | string | Source of the key material. The origin of the key can be: • cckm: Key material is created on CCKM. • native: Key material is created on the AWS cloud. • unknown: Source of the key material is unknown. It is different than CCKM and the native cloud. |
key_source | string | Name of the key material source. • LunaHSM (HSM Luna)• DSM (Data Security Manager)• LOCAL (CipherTrust Manager) |
multi_region | boolean | Whether the key is a multi-region key. Specify true for a multi-region key, false for a single-region key. |
multi_region_key_type | string | Type of the multi-region key, PRIMARY or REPLICA. |
skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. |
limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter ) will be displayed in the output. |
sort | string | Comma-delimited list of properties to sort the results. |
blocked | boolean | Fetches keys based on the block state. |
custom_key_store_id | string | Fetches keys based on the custom key store id. |
custom_key_store_name | string | Fetches keys based on the custom key store name. |
Example Request
Example Response
The sample output shows the list of the AWS keys.
To know more about response parameters, refer to Response Parameters of Key Life Cycle Management APIs.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.