REST API - decrypt
  1. Operations
  2. esx
  3. kms
  4. key operation

esx kms key operation: decrypt

Decrypt ciphertext.

Request:

HTTP request

POST https://{server}/rest/esx/kms/key-operation?action=decrypt

Request Body Structure:

{
    "ciphertext" : "string",
    "provider" : "obj-103"
}

Request Body Parameters:

Name Type Description
bold = required
provider string Identifier of the Key Provider.
ciphertext string Ciphertext to decrypt.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "plaintext" : "secret string"
    }
}

Response Type:

Name Type Description
bold = required
value decrypt_result Decrypted ciphertext.
value.plaintext secret The decrypted data.

Errors:

HTTP Status Code Type Description
400 invalid_argument if the arguments are invalid.
404 not_found if the provider is not found.
401 unauthenticated if the caller is not authenticated.
403 unauthorized if the caller is not authorized.
500 error if any other error occurs.