Crypto Manager Add Key

Crypto Manager Add Key

Add an existing key.

Required privileges: Cryptographer.ManageKeys

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/CryptoManager/{moId}/AddKey
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 CryptoManager/{moId}.

string
release
Required

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

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

Show optional properties

{
    "key": {
        "keyId": {
            "keyId": "string"
        },
        "algorithm": "string",
        "keyData": "string"
    }
}
{
    "key": {
        "_typeName": "string",
        "keyId": {
            "_typeName": "string",
            "keyId": "string",
            "providerId": {
                "_typeName": "string",
                "id": "string"
            }
        },
        "algorithm": "string",
        "keyData": "string"
    }
}
CryptoKeyPlain
key
Required

Data Object representing a plain text cryptographic key.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

AlreadyExists: in case the key is already in the key cache

InvalidState: in case the host is not Crypto Safe

InvalidArgument: in case the keyID is duplicated or key properties are incorrect.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Virtual Infrastructure Operations
POST
Crypto Manager Add Key
POST
Crypto Manager Add Keys
GET
Crypto Manager Get Enabled
POST
Crypto Manager List Keys
POST
Crypto Manager Remove Key
POST
Crypto Manager Remove Keys