v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Aws

Return kmskeys

Return kmskeys by region and account

get/organizations/{organization_id}/accounts/{account_id}/aws/regions/{region}/kmskeys

Path parameters

organization_idstring required

Organization Id of the Organization that you are working with. This can be found by looking at the organization id in the URL of the dashboard. These are randomly generated alphanumber values

account_idstring required

Account id of the CloudRanger Account that you are managing inside an organization, these can be found by call the /organizations/{organization_id}/accounts endpoints which returns all accounts inside an Organization These are randomly generated alphanumber values

region'us-east-1' | 'us-east-2' | 'us-west-1' | 'us-west-2' | 'af-south-1' | 'ap-southeast-4' | 'ap-east-1' | 'ap-south-2' | 'ap-southeast-3' | 'ap-south-1' | 'ap-northeast-3' | 'ap-northeast-2' | 'ap-southeast-1' | 'ap-southeast-2' | 'ap-northeast-1' | 'ca-central-1' | 'eu-central-1' | 'eu-west-1' | 'eu-west-2' | 'eu-south-1' | 'eu-west-3' | 'eu-south-2' | 'eu-north-1' | 'eu-central-2' | 'me-south-1' | 'me-central-1' | 'il-central-1' | 'sa-east-1' | 'us-gov-west-1' | 'us-gov-east-1' required

The region that you want to perform the request against. This can be found by checking where your resource is located in the CloudRanger console or in the AWS console

Response

200 response

Aliasstring
KeyIdstring
KeyState'AccessDenied' | 'Creating' | 'Enabled' | 'Disabled' | 'PendingDeletion' | 'PendingImport' | 'PendingReplicaDeletion' | 'Unavailable' | 'Updating'