Updating Key Description
Use the post /v1/cckm/aws/keys/{id}/update-description
API to update the description of an AWS key.
Syntax
Here, {id}
represents the key ID.
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
description | string | Updated description for the key. |
Example Request
Example Response
The sample output reflects the updated description (key-description
) for the key (with ID baf58871-2503-4d13-a84a-339aeb8fdfaf
).
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.