API Endpoints and Organization
There exists two suites of Storage APIs:
- S3 compatible, and
- JSON companion
S3 Compatible APIs
This suite of APIs is compatible with AWS S3; as a result, minimal changes to existing integration are needed for migration to Telnyx.
Endpoints | Region |
us-central-1.telnyxstorage.com | us-central-1 |
us-east-1.telnyxstorage.com | us-east-1 |
us-west-1.telnyxstorage.com | us-west-1 |
Any of the above regional endpoints can fulfill ListBuckets
and GetBucketLocation
API requests regardless of the location of each of the user’s buckets. However, all other API methods need to be directed at the regional endpoint that the bucket is homed. Otherwise an error will be returned. Hence, it is advisable to query the location of the bucket first before forming the correct regional endpoint for all subsequent API operations.
Supported S3 APIs are documented in this table.
JSON Companion API
This suite of APIs is an extension to the S3 API, accommodating the following functionalities:
API endpoint to be used is api.telnyx.com
.