Skip to main content

​
Telnyx Storage — Documentation Index

S3-compatible cloud storage with buckets, SDKs, and migration from AWS. One section of the Telnyx developer docs (https://developers.telnyx.com). Root index: https://developers.telnyx.com/llms.txt · Full content for this section: https://developers.telnyx.com/development/llms/storage-llms-full-txt.md

​
Subsections

Focused per-subsection files (index + full content):

​
Object Storage

  • Overview: Telnyx Cloud Storage is S3-compatible object storage — store and serve files, media, backups, and assets over the AWS S3 API, from your SDKs and CLI, or directly from a Telnyx Edge Function.
  • Quick Start Guide: Quickstart for Telnyx Cloud Storage — create a bucket, generate S3-compatible credentials, and upload your first object using the AWS CLI or any S3 client.
  • API Endpoints & Organization: Discover Telnyx Cloud Storage API endpoints: Key details on regions, S3 compatibility, and API usage instructions.
  • Authentication: >-
  • Bucket Addressing: Learn about bucket addressing in Telnyx Cloud Storage, including
  • Node.js: Use the AWS SDK for Node.js with Telnyx Cloud Storage. Configure the S3-compatible endpoint and upload, download, and list objects from JavaScript apps.
  • Python: Use boto3 (AWS SDK for Python) with Telnyx Cloud Storage. Configure the S3-compatible endpoint and upload, download, and list objects from Python apps.
  • Java: Use the AWS SDK for Java with Telnyx Cloud Storage. Configure the S3-compatible endpoint and upload, download, and list objects from Java applications.
  • Go: Use the AWS SDK for Go with Telnyx Cloud Storage. Configure the S3-compatible endpoint and upload, download, and list objects from Go applications.
  • Ruby: Use the AWS SDK for Ruby with Telnyx Cloud Storage. Configure the S3-compatible endpoint and upload, download, and list objects from Ruby applications.
  • PHP: Use the AWS SDK for PHP with Telnyx Cloud Storage. Configure the S3-compatible endpoint and upload, download, and list objects from PHP applications.
  • .NET: Use the AWS SDK for .NET with Telnyx Cloud Storage. Configure the S3-compatible endpoint and upload, download, and list objects from C# applications.
  • Elixir: Use ExAws with Telnyx Cloud Storage. Configure the S3-compatible endpoint and upload, download, and list objects from Elixir and Phoenix applications.
  • Third Party Applications: Discover the compatibility of Telnyx Storage with S3 third-party
  • Edge Function Binding: Bind a Cloud Storage bucket to a Telnyx Edge Function and read, write, and list objects through a pre-authenticated env binding. No S3 keys in your code.
  • Binding API Reference: The Cloud Storage binding surface exported from @telnyx/edge-runtime — get, put, head, delete, list, and multipart on the env binding, including ranged and conditional reads, batch delete, hierarchic…
  • Multipart Upload: Upload large files to Telnyx Cloud Storage with multipart uploads. Split objects into parts, upload in parallel, and complete or abort the upload via S3 API.
  • Presigned URLs: “Information on presigned URLs in Telnyx Cloud Storage: Current
  • Object Encryption: “Implementing object encryption in Telnyx Cloud Storage using
  • Public Buckets: Make a Telnyx Cloud Storage bucket public so its objects are readable over HTTPS. Set bucket-level ACLs and policies for static hosting or asset delivery.
  • HTTPS with Custom Domain: You may use Telnyx storage as the backend to serve your content
  • Data Protection & Retention: Protect Telnyx Cloud Storage objects from deletion with Object Lock and Retention. Configure governance or compliance modes and set retention periods.
  • Emptying Buckets: Delete all objects from a Telnyx Cloud Storage bucket before removing it. Use the Mission Control portal or the S3-compatible API to bulk empty buckets.
  • AWS S3 Compatibility: Navigate AWS S3 compatibility in Telnyx Cloud Storage, focusing on supported headers and API methods.
  • Compatibility Matrix: Review the comprehensive compatibility matrix for Telnyx Cloud
  • Migration from AWS S3: The migration API moves all data from a source AWS S3 bucket to a
  • Limits & Quotas: Limits for Telnyx Cloud Storage — bucket count, object size, multipart upload sizes, request rate, and object encryption limits per account and region.
  • Billing & Pricing: Understand Telnyx Cloud Storage billing—Details on charges for
  • Performance Benchmarks: “Understand Telnyx Storage’s capabilities: Summary of performance
  • Create bucket: Learn to create a bucket in Telnyx Cloud Storage, with details on
  • Delete bucket: “Deleting buckets in Telnyx Cloud Storage: Simple guide with
  • Delete bucket CORS: Simple steps to delete bucket CORS settings in Telnyx Cloud Storage
  • Delete bucket lifecycle: Efficiently manage bucket lifecycles in Telnyx Cloud Storage with
  • Delete bucket policy: Learn to delete bucket policies in Telnyx Cloud Storage using AWS
  • Delete bucket tagging: Learn how to efficiently remove tagging from buckets in Telnyx
  • Get bucket ACL: Learn to access bucket ACL information in Telnyx Cloud Storage
  • Get bucket CORS: Learn to retrieve bucket CORS settings in Telnyx Cloud Storage
  • Get bucket lifecycle configuration: Learn to access lifecycle settings for buckets in Telnyx Cloud
  • Get bucket location: Easily identify the location of buckets in Telnyx Cloud Storage
  • Get bucket policy: Learn to retrieve bucket policies in Telnyx Cloud Storage with a
  • Get bucket policy status: Easily assess the policy status of Telnyx Cloud Storage buckets
  • Get bucket tagging: Understand bucket tagging in Telnyx Cloud Storage with example API
  • Get bucket versioning: “Learn to manage bucket versioning in Telnyx Cloud Storage:
  • Head bucket: Learn how to perform a HeadBucket request in Telnyx Cloud Storage
  • List buckets: Learn to quickly list and view all buckets in Telnyx Cloud Storage,
  • Put bucket ACL: Guide to configuring ACLs for buckets in Telnyx Cloud Storage using
  • Put bucket CORS: Set up CORS rules for your Telnyx Cloud Storage buckets with this
  • Put bucket lifecycle configuration: Set up lifecycle configurations for your Telnyx Cloud Storage
  • Put bucket policy: Learn to apply bucket policies for public access in Telnyx Cloud
  • Put bucket tagging: Efficiently manage bucket tags in Telnyx Cloud Storage with a clear
  • Put bucket versioning: Learn to set up bucket versioning in Telnyx Cloud Storage using XML
  • Delete object: “Guide to removing objects from Telnyx Cloud Storage: Detailed
  • Delete object tagging: Efficiently delete tags from objects in Telnyx Cloud Storage with
  • Delete objects: Learn how to bulk delete objects in Telnyx Cloud Storage using AWS
  • Get object: “Guide on accessing objects in Telnyx Cloud Storage: Utilize API
  • Get object ACL: Efficiently manage object ACLs in Telnyx Cloud Storage using AWS S3
  • Get object tagging: “Guide to accessing object tags in Telnyx Cloud Storage: Utilize
  • Head object: Learn to perform HeadObject requests in Telnyx Cloud Storage,
  • List object versions: “Guide to tracking object versions in Telnyx Cloud Storage: Utilize
  • List objects: Learn to efficiently list objects within Telnyx Cloud Storage
  • Put object: Learn to upload objects to Telnyx Cloud Storage with detailed AWS
  • Put object ACL: Set access control lists for objects in Telnyx Cloud Storage using
  • Put object tagging: Add custom tags to your objects in Telnyx Cloud Storage using the
  • Abort multipart upload: Learn to abort multipart uploads in Telnyx Cloud Storage with
  • Complete multipart upload: “Finalize multipart uploads in Telnyx Cloud Storage: A detailed
  • Create multipart upload: “Initiate multipart uploads in Telnyx Cloud Storage: Learn about
  • List multipart uploads: Efficiently manage multipart uploads in Telnyx Cloud Storage by
  • Upload parts: Learn to upload parts of a file in Telnyx Cloud Storage using
  • List parts: Master the management of multipart uploads in Telnyx Cloud Storage

​
KV

  • KV: Telnyx KV is globally distributed key-value storage for low-latency reads from edge functions. Use it through the function binding or the REST API.
  • Quick Start: Create a KV namespace, bind it to your edge function, and read or write data — through the function binding or the REST API.
  • How KV Works: The Telnyx KV data model: path-like keys, opaque byte values, optional server-side TTL, no per-key metadata, and a single global store with read-your-writes consistency.
  • Key Expiration: Telnyx KV supports server-side TTL — set it when writing through the binding, as a REST parameter, or with a CLI flag — so keys expire automatically.
  • Session Storage: Store user sessions at the edge with Telnyx KV and expire them with a server-side TTL.
  • API Response Caching: Cache expensive upstream API responses at the edge with Telnyx KV and a short server-side TTL.
  • Feature Flags: Read feature flags on the request path from Telnyx KV and flip them without redeploying.
  • Overview: The KV runtime API — the methods available on a bound namespace, plus their option and result types.
  • KvNamespace: The KV binding’s runtime API — read, write, delete, and list on a bound namespace, with option and result types and their behavior.
  • CLI: Manage Telnyx KV namespaces and keys from your terminal with the CLI — create, list, put, get, and delete.
  • Best Practices: Practical guidance for Telnyx KV: naming keys, serializing values, and handling missing keys.
  • Pricing: Pricing for Telnyx KV: free tier limits and per-million-operation rates for reads, writes, deletes, and lists, with free egress.

​
CloudFS (Beta)

  • CloudFS: CloudFS is a POSIX filesystem you mount on any host or container, backed by Telnyx Cloud Storage — a shared, persistent filesystem for AI agents that you mount once.
  • Quick Start: Create a CloudFS filesystem over the API, mount it with the JuiceFS client inside a Linux container, and read and write files over POSIX.
  • Filesystems From First Principles: What a filesystem actually is — files, inodes, and directories — and how a local one is implemented: a metadata index (inodes and bitmaps) over a region of data blocks.
  • Network Filesystems: Why the classic network filesystems — Sun’s NFS and the Andrew File System — don’t fit a fleet of ephemeral agents over the WAN, and how GFS, HDFS, and MooseFS reframed storage: an authoritative meta…
  • How CloudFS Works: How CloudFS works: JuiceFS’s synthesis of the metadata/data split — a transactional metadata database plus object storage, served by a rich client with no server in the data path — and the two-lane a…
  • Mounting a Filesystem: Mount a CloudFS filesystem through FUSE with the JuiceFS Community Edition client — on Linux, in Docker, or on macOS — using the metadata URL and your Telnyx API key.
  • Serving Without FUSE: Serve a CloudFS filesystem over WebDAV with juicefs webdav — no FUSE, no kernel extension — and mount the endpoint natively in Finder on macOS.
  • Concurrent Access: Mount the same CloudFS filesystem from many clients at once and read and write it concurrently — with cross-client visibility (close-to-open) and file locks for coordinating writers.

​
API Reference (Storage)

​
Presigned Object URLs

  • Create Presigned Object URL: Returns a timed and authenticated URL to download (GET) or upload (PUT) an object. This is the equivalent to AWS S3’s “presigned” URL. Please note that Telnyx…

​
Bucket SSL Certificate

​
Bucket Usage

  • Get API Usage: Returns the detail on API usage on a bucket of a particular time period, group by method category.
  • Get Bucket Usage: Returns the amount of storage space and number of files a bucket takes up.

​
Data Migration

​
kv namespaces

  • List KV namespaces: Lists the KV namespaces for the authenticated user’s organization. Results use page-based pagination (page[number]/page[size]).
  • Create a KV namespace: Creates a new KV namespace. Provisioning is asynchronous: the namespace is returned with status pending and becomes usable once it reaches provision_ok.
  • Get a KV namespace: Retrieves a KV namespace by its ID, including its provisioning status.
  • Delete a KV namespace: Deletes a KV namespace and all of the keys it contains. Deletion is asynchronous: the namespace is returned with status deleting. Deleting a namespace whose…

​
kv keys

  • List keys: Lists the keys in a namespace. Returns key names and metadata only, never values. Results are paginated with limit and an opaque cursor.
  • Get a key’s value: Returns the raw stored value for a key. The response body is the value exactly as it was written; the Content-Type header echoes the value’s stored content t…
  • Set a key’s value: Creates or replaces the value for a key. The request body is stored verbatim as the value — no base64, no JSON envelope — up to 1 MiB. The request’s `Content-T…
  • Delete a key: Deletes a key. Idempotent: deleting a key that does not exist still succeeds. The namespace itself must exist and be provisioned.

​
cloudfs filesystems

  • List CloudFS filesystems: Lists the CloudFS filesystems for the authenticated user’s organization. Results use cursor-based pagination: fetch the next page by passing `meta.cursors.afte…
  • Create a CloudFS filesystem: Creates a CloudFS filesystem. Provisioning is synchronous — typically a few seconds, up to a few minutes — and the filesystem is returned with status ready,…
  • Get a CloudFS filesystem: Retrieves a CloudFS filesystem by its ID. The returned meta_url omits the credential — the metadata token is only ever returned by create and rotate-meta-tok…
  • Update a CloudFS filesystem: Updates a CloudFS filesystem. Only name can be changed; other fields are immutable and unknown fields are rejected with a 400. Renaming to a name that alre…
  • Delete a CloudFS filesystem: Permanently deletes a CloudFS filesystem, removing its S3 bucket and its metadata database. Deletion is synchronous: the response returns the filesystem’s fina…
  • Rotate the metadata token: Issues a new metadata access token for the filesystem and returns the full filesystem, including the new meta_token and credential-bearing meta_url. The pr…