This documentation is for reference only. We are no longer onboarding new customers to Programmable Video. Existing customers can continue to use the product until December 5, 2026.
We recommend migrating your application to the API provided by our preferred video partner, Zoom. We've prepared this migration guide to assist you in minimizing any service disruption.
This feature is only available through Twilio Enterprise Edition or Security Edition. For further information, contact the Twilio sales team.
The Twilio Composition Settings REST API lets you configure Twilio to store your compositions encrypted. Composition Settings work per-account (i.e. project). If you activate encryption, all Video Compositions in your account (or project) will get encrypted.
This document contains reference information about the Composition Settings REST API for encryption. For a step-by-step guide, you can also read the Encrypting your Stored Media developer guide
These are the URI schemes for the Composition Settings REST API and the supported methods:
/v1/CompositionSettings/Default
GET
: Retrieves current Composition Settings.
POST
: Updates the Composition Settings.
The Default CompositionSettings resource holds the default composition settings for the given Twilio account (or project). Its configuration will be applied to all Recording Compositions created in such account (or project).
The Compositions Settings default resource is located at the following Base URL:
_10https://video.twilio.com/v1/CompositionSettings/Default
A CompositionSettings resource has the following properties:
The SID of the Account that created the CompositionSettings resource.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The string that you assigned to describe the resource and that will be shown in the console
The SID of the stored Credential resource.
^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34The URL of the AWS S3 bucket where the compositions are stored. We only support DNS-compliant URLs like https://documentation-example-twilio-bucket/compositions, where compositions is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986.
Whether all compositions are written to the aws_s3_url. When false, all compositions are stored in our cloud.
The SID of the Public Key resource used for encryption.
^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34Whether all compositions are stored in an encrypted form. The default is false.
The absolute URL of the resource.
In the table above, the following properties are reserved for the feature called External S3 Storage:
aws_credentials_sid
aws_s3_url
aws_storage_enabled
Retrieves your account's default Composition Settings.
For example:
Sets your account's default Composition Settings. POST requests support the
following parameters:
A descriptive string that you create to describe the resource and show to the user in the console
The SID of the stored Credential resource.
^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Public Key resource to use for encryption.
^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like https://documentation-example-twilio-bucket/compositions, where compositions is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986.
Whether all compositions should be written to the aws_s3_url. When false, all compositions are stored in our cloud.
Whether all compositions should be stored in an encrypted form. The default is false.
In the table above, the following parameters are reserved for the feature called External S3 Storage:
AwsCredentialsSid
AwsS3Url
AwsStorageEnabled
The following code snippets illustrate how you can set Encryption in your Compositions settings: