Verifying Alias on AWS KMS
Use the post /v1/cckm/aws/alias/verify
API to check the availability of an alias on the AWS KMS.
Syntax
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
alias | string | Key alias to be verified. |
kms | string | ID or name of the KMS. |
region | string | Region in which the alias is to be verified. |
Example Request
Example Response
The sample output shows that the alias (newalias
) is available on the KMS (kms-name
) and the "Alias available"
message is returned in response.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.