Cloud Storage quick start

There are five ways to get started on Telnyx cloud storage:

Cloud Storage binding — from inside a Telnyx Edge Function
AWS SDK
AWS CLI
S3-compatible third-party tools
Telnyx Mission Control Portal

Available Regions

Region	Endpoint
us-central-1	us-central-1.telnyxcloudstorage.com
us-east-1	us-east-1.telnyxcloudstorage.com
us-west-1	us-west-1.telnyxcloudstorage.com
eu-central-1	eu-central-1.telnyxcloudstorage.com
ap-southeast-1	ap-southeast-1.telnyxcloudstorage.com

Specify the region via the --endpoint-url flag in the AWS CLI or the equivalent SDK configuration. See API Endpoints & Organization for details on regional behavior.

Some features are currently available only in US and APAC regions, including presigned URLs, public buckets, and SSL certificates. EU buckets do not support these features. See the compatibility matrix for full details.

Use a Cloud Storage binding

Bind an existing bucket to a Telnyx Edge Function and read, write, and list objects through a pre-authenticated env binding — the runtime injects the credential, so your code holds no S3 keys. This is the fastest path if your code already runs on Telnyx Edge Compute. See Use a bucket from an Edge Function to declare the binding and call env.MY_BUCKET.get/put/head/delete/list.

Use the AWS SDK

Telnyx Cloud Storage is S3-compatible, so the AWS SDKs work against it. See the ready-to-run examples for Node, Python, Java, Go, Ruby, PHP, .NET, and Elixir.

Use the AWS CLI

Install AWS CLI locally

Follow the procedure here.

Use a recent AWS CLI v2. The Cloud Storage endpoint accepts the AWS CLI’s default checksums (CRC64NVME) on both put-object and aws s3 cp multipart uploads.

Configure CLI

Inject your Telnyx API key twice, once as access key and once as secret key.
Leave the region as blank; regionality is specified via --endpoint-url as shown subsequently.

user@localhost ~ % aws configure --profile mytelnyxprofile 
AWS Access Key ID [None]: XXX
AWS Secret Access Key [None]: XXX
Default region name [None]: 
Default output format [None]: json

Validate the profile has been created successfully.

user@localhost ~ % aws configure list-profiles
mytelnyxprofile

Validate CLI configuration

Perform the following validation procedure to ensure everything is working as expected.Create 2 bucketsBucket names must be universally unique. Hence, BucketAlreadyExists error is expected on first attempt.

user@localhost ~ % aws s3api create-bucket --bucket demo-bucket --profile mytelnyxprofile --endpoint-url https://us-east-1.telnyxcloudstorage.com
An error occurred (BucketAlreadyExists) when calling the CreateBucket operation: Unknown
user@localhost ~ % aws s3api create-bucket --bucket demo-bucket-n1 --profile mytelnyxprofile --endpoint-url https://us-east-1.telnyxcloudstorage.com
user@localhost ~ % aws s3api create-bucket --bucket demo-bucket-n2 --profile mytelnyxprofile --endpoint-url https://us-east-1.telnyxcloudstorage.com

List bucketsVerify the buckets were created successfully.

user@localhost ~ % aws s3api list-buckets --profile mytelnyxprofile --endpoint-url https://us-east-1.telnyxcloudstorage.com
{
    "Buckets": [
        
        {
            "Name": "demo-bucket-n1",
            "CreationDate": "2024-07-26T17:31:14.888000+00:00"
        },
        {
            "Name": "demo-bucket-n2",
            "CreationDate": "2024-07-26T17:31:25.225000+00:00"
        }
    ],
    "Owner": {
        "DisplayName": "XXX",
        "ID": "XXX"
    }
}

Add objects to a bucketUpload some random objects.

user@localhost ~ % aws s3api put-object --key demo-obj-101 --body ~/Downloads/IMG_1752.mov --bucket demo-bucket-n1 --profile mytelnyxprofile --endpoint-url https://us-east-1.telnyxcloudstorage.com
{
    "ETag": "\"bc864c2bc4549d72abadb0a5d44ee788\""
}

user@localhost ~ % aws s3api put-object --key demo-obj-202 --body ~/Downloads/IMG_1753.mov --bucket demo-bucket-n1 --profile mytelnyxprofile --endpoint-url https://us-east-1.telnyxcloudstorage.com
{
    "ETag": "\"bc864c2bc4549d72babdb0a5d44ee988\""
}

List objectsVerify the objects were uploaded successfully.

user@localhost ~ % aws s3api list-objects-v2 --bucket demo-bucket-n1 --profile mytelnyxprofile --endpoint-url https://us-east-1.telnyxcloudstorage.com 
{
    "Contents": [
        {
            "Key": "demo-obj-101",
            "LastModified": "2024-07-26T17:34:52.428000+00:00",
            "ETag": "\"bc864c2bc4549d72abadb0a5d44ee788\"",
            "Size": 136994934,
            "StorageClass": "STANDARD"
        },
        {
            "Key": "demo-obj-202",
            "LastModified": "2024-07-26T17:36:31.799000+00:00",
            "ETag": "\"bc864c2bc4549d72babdb0a5d44ee988\"",
            "Size": 136994934,
            "StorageClass": "STANDARD"
        }
    ],
    "RequestCharged": null
}

Use S3-compatible third-party tools

Many excellent tools exist to upload data at scale without any code. You can find the configuration guides here.

Use the Telnyx Mission Control Portal

Follow this support article.

Read these documentations

Some key differences exist between Telnyx cloud storage and AWS S3. It’s advisable that they are reviewed and comprehended prior to Telnyx cloud storage is put into production.

Understand API endpoints & organizations
Review supported API methods
Heed the warning on presigned URL
Pay attention to billing
Know the restrictions on policy and ACL

Additional Resources

All available AWS S3 CLI Commands

Overview

Get Started

Concepts

Access via S3 API

Access from Edge Compute

Features

Compatibility & Migration

Platform

API Reference (S3-Compatible)

API Reference (JSON Companion)

For AI Agents

Cloud Storage quick start

Available Regions

Use a Cloud Storage binding

Use the AWS SDK

Use the AWS CLI

Use S3-compatible third-party tools

Use the Telnyx Mission Control Portal

Read these documentations

Additional Resources

​Available Regions

​Use a Cloud Storage binding

​Use the AWS SDK

​Use the AWS CLI

​Use S3-compatible third-party tools

​Use the Telnyx Mission Control Portal

​Read these documentations

​Additional Resources

Available Regions

Use a Cloud Storage binding

Use the AWS SDK

Use the AWS CLI

Use S3-compatible third-party tools

Use the Telnyx Mission Control Portal

Read these documentations

Additional Resources