Delete KMS server

Content Platform for Cloud Scale Management API Reference

Part Number

You can delete the connection to an external secondary KMS server. The server is not deleted, only the connection to the server.

HTTP request syntax (URI)

POST https://host_ip:9099/mapi/v1/kmip/delete_server

Request structure

"name": "name"
Parameter Required Type Description
name Yes String The user-assigned name of the secondary KMS server you want to delete. Type up to 63 Unicode characters.

Response structure

Not applicable.

Return codes

Note: Before deleting the connection to a secondary KMS server, the system checks the KEKs currently on the reachable online servers. If each KEK on the server is contained in the set of currently available KEKs, the connection to the server is deleted and the method succeeds. However, if the server contains a KEK not available on at least one of the other servers, the connection is not deleted and the method fails.

Status code

HTTP name


200 OK The request was executed successfully.
401 Unauthorized Access was denied because credentials are not valid.
405 Method Not Allowed The specified HTTP method is not allowed for a storage component. Resend using POST.
503 Service Unavailable An external KMS system has not been configured.


Request example:


JSON request:

"name": "myServer"