Crypto Manager Kmip Remove Key

Crypto Manager Kmip 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://{vcenter-host}/sdk/vim25/{release}/CryptoManagerKmip/{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 CryptoManagerKmip/{moId}.

string
release
Required

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

Request Body
RemoveKeyRequestType of type(s) application/json
Required

Show optional properties

{
    "key": {
        "keyId": "string"
    },
    "force": false
}
{
    "key": {
        "_typeName": "string",
        "keyId": "string",
        "providerId": {
            "_typeName": "string",
            "id": "string"
        }
    },
    "force": false
}
CryptoKeyId
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
This response body class contains all of the following: VimFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "type": "string",
    "name": "string"
}
string
type
Optional

Type of resource that is in use.

string
name
Optional

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


On This Page
Virtual Infrastructure Operations
POST
Crypto Manager Kmip Add Key
POST
Crypto Manager Kmip Add Keys
POST
Crypto Manager Kmip Generate Client Csr
POST
Crypto Manager Kmip Generate Key
POST
Crypto Manager Kmip Generate Self Signed Client Cert
POST
Crypto Manager Kmip Get Default Kms Cluster
GET
Crypto Manager Kmip Get Enabled
GET
Crypto Manager Kmip Get Kmip Servers
POST
Crypto Manager Kmip Is Kms Cluster Active
POST
Crypto Manager Kmip List Keys
POST
Crypto Manager Kmip List Kmip Servers
POST
Crypto Manager Kmip List Kms Clusters
POST
Crypto Manager Kmip Mark Default
POST
Crypto Manager Kmip Query Crypto Key Status
POST
Crypto Manager Kmip Register Kmip Server
POST
Crypto Manager Kmip Register Kms Cluster
POST
Crypto Manager Kmip Remove Key
POST
Crypto Manager Kmip Remove Keys
POST
Crypto Manager Kmip Remove Kmip Server
POST
Crypto Manager Kmip Retrieve Client Cert
POST
Crypto Manager Kmip Retrieve Client Csr
POST
Crypto Manager Kmip Retrieve Kmip Server Cert
POST
Crypto Manager Kmip Retrieve Kmip Servers Status Task
POST
Crypto Manager Kmip Retrieve Self Signed Client Cert
POST
Crypto Manager Kmip Set Default Kms Cluster
POST
Crypto Manager Kmip Set Key Custom Attributes
POST
Crypto Manager Kmip Unregister Kms Cluster
POST
Crypto Manager Kmip Update Kmip Server
POST
Crypto Manager Kmip Update Kms Signed Csr Client Cert
POST
Crypto Manager Kmip Update Self Signed Client Cert
POST
Crypto Manager Kmip Upload Client Cert
POST
Crypto Manager Kmip Upload Kmip Server Cert