Skip to content

Update encrypt key

To modify the encryption key, submit the following PUT request with JSON-formatted data.

PUT /api/v2/encrypt_keys/<encrypt-key-id>.json

HTTP body should contain JSON-formatted data with the following parameters:

Field Type Description
name string Human-readable encrypt key name.
is_active boolean If true, then the new key will be used for encrypting of all on-going recordings for that tenant. If false, then the key will be used only for accessing previously encrypted recordings with that key.

Example of JSON data to submit:

{
    "encrypt_key":
    {
        "name": "New name for encrypt key"
        "is_active": false,
    }
}

Response contains HTTP status code as shown in the following table.

Response Description
200 OK Encryption key has been successfully updated
403 Forbidden The request cannot be completed because API user has no permission to edit encryption keys
400 Bad Request

The request cannot be completed because supplied JSON object has invalid data.

When response has content type application/json, then it contains more detailed description of error in JSON format like:

{"error": "InvalidRecord", "description": "Record Validation errors","details": ["is_active": "Should be boolean type"]}