Crypto Manager Host KMS Remove Key

Crypto Manager Host KMS Remove Key

Remove a key (only the UUID is needed to remove).

If "force" is set, removal will happen even if the key is in use.

Required privileges: Cryptographer.ManageKeys

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/CryptoManagerHostKMS/{moId}/RemoveKey
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case CryptoManagerHostKMS/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body
RemoveKeyRequestType of type(s) application/json
Required 
"RemoveKeyRequestType Object"
object
key
Required

Data Object representing a cryptographic key.

boolean
force
Required

[in] Remove the key even if in use or not existent.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

InvalidArgument: in case the keyID is not found and "force" is false.

ResourceInUse: if the key is used to encrypt any object and "force" is false.

Returns ResourceInUse of type(s) application/json 
"ResourceInUse Object"
string
type
Optional

Type of resource that is in use.

string
name
Optional

Name of the instance of the resource that is in use.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/CryptoManagerHostKMS/{moId}/RemoveKey
On This Page
Crypto Manager Host Kms Operations
POST
Crypto Manager Host KMS Add Key
POST
Crypto Manager Host KMS Add Keys
POST
Crypto Manager Host KMS Change Key Task
POST
Crypto Manager Host KMS Crypto Manager Host Disable
POST
Crypto Manager Host KMS Crypto Manager Host Enable
POST
Crypto Manager Host KMS Get Crypto Key Status
POST
Crypto Manager Host KMS List Keys
POST
Crypto Manager Host KMS Crypto Manager Host Prepare
POST
Crypto Manager Host KMS Remove Key
POST
Crypto Manager Host KMS Remove Keys
GET
Crypto Manager Host KMS Get Enabled