Skip to main content

Decrypt blob

post
/api/pvlt/1.0/data/collections/{collection}/decrypt/blob

Decrypts ciphertext and returns the plaintext as raw bytes (application/octet-stream) not a JSON object.

See Decrypt for more information about the decryption process and request parameters.

Request

Path parameters

  • collection - string required*

    The name of a collection.

Query parameters

  • options - array of strings

    Options for the operation. Options include:

    • archived – whether to decrypt only archived objects. If not specified, decrypts only active objects.
    Each string:

    Option for the operation.

  • adhoc_reason - string

    An ad-hoc reason for accessing the Vault data. Required when reason is set to Other.

  • reason - string required*

    Details of the reason for requesting the property. The default is set when no access reason is provided and PVAULT_SERVICE_FORCE_ACCESS_REASON is false.

  • reload_cache - boolean

    Reloads the cache before the action.

  • prop - string required*

    The name of a property.

  • scope - string

    A classification for the encrypted object that is added to the ciphertext as associated data (AAD). An object encrypted with a scope can be decrypted only with the same scope.

Request body

Details of the decryption request.

string required*
Example
string

Possible responses

The request is successful.

string required*
Example
string

Try the API

Authorization

Path parameters

Query parameters

Request body

Navigate to the docs of your local Vault installation to try the API directly from there.

Code examples

Example