Deleting a Key Alias
Function
Delete an alias.
Calling Method
For details, see Calling APIs.
URI
DELETE /v1.0/{project_id}/kms/aliases
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
aliases |
Yes |
Array of strings |
Alias to be deleted |
|
key_id |
Yes |
String |
ID of the key associated with the alias |
Response Parameters
Status code: 204
The alias is deleted.
None
Example Requests
Delete aliases kms-1234 and kms-4567 from the associated bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e key.
{
"key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"aliases" : [ "kms-1234", "kms-4567" ]
}
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
204 |
The alias is deleted. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
