Source Media Decryption

If your source media files are encrypted at rest, and would be retrieved with encryption still in place (usually called client-side encryption), we have a number of methods to decrypt those assets for processing. Just add following decryption parameters to your API request.

If native at-rest encryption is applied to files, but they are delivered decrypted (usually called server-side encryption), these parameters are not needed.

<?xml version="1.0"?>
<query>
    <userid><<i>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>[FileURL]</source>
    <decryption>[yes|no]</decryption>
    <decryption_method>[aes-128-cbc|aes-128-ctr|aes-256-cbc|aes-256-ctr]</decryption_method>
    <decryption_key>[Hexidecimal string]</decryption_key>
    <decryption_key_file>[URL]</decryption_key_file>
    <decryption_iv>[Hexidecimal string]</decryption_iv>
    <decryption_password>[Password]</decryption_password>
    <format>
        <!-- Format Fields -->
    </format>
</query>
{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "source": "[FileURL]",
        "decryption": "[yes|no]",
        "decryption_method": "[aes-128-cbc|aes-128-ctr|aes-256-cbc|aes-256-ctr]",
        "decryption_key": "[Hexidecimal string]",
        "decryption_key_file": "[URL]",
        "decryption_iv": "[Hexidecimal string]",
        "decryption_password": "[Password]",
        "format": ""
    }
}

Parameter

Description

Allowed Values

Default`

decryption

Is decryption necessary of the source?

yes, no

no

decryption_method

Specify the encryption scheme.

aes-128-cbc, aes-128-ctr, aes-256-cbc, aes-256-ctr

aes-128-cbc

decryption_key

The key used to decrypt your source content.

32 hexidecimal characters ([0-9a-f])

None

decryption_key_file

Specify the URL where the key file is hosted.

Valid URL to decryption key file.

None

decryption_iv

Specify an initialization vector.

32 hexidecimal characters ([0-9a-f])

None

decryption_password

Password used to encrypt the initialization vector.

any set of characters

None