Authenticating a Request

In order to execute the sample Transform API requests in this section you will need the following:

API Key

An API key is a 28 character string that starts with tcs_. A key must be included with every API request using the X-Api-Key HTTP request header. The key is used by the REST API for authentication and authorization.

All of the examples in this section use tcs_YOUR_API_KEY as a placeholder which must be replaced with a real value for actual API requests.

To get an API key login to the Telestream Cloud console, click on your user name (in the upper right corner) and select IAM (Identity and Access Management). In the Your API Keys view you can find an existing key or create a new one.

Store ID

The storage management system provides a registry of storage locations that can be used by different Telestream Cloud services. Each named store contains all of the information necessary to read files from, or write files to, a specific storage location. This information includes:

  • the storage type: AWS S3, Azure Blob Storage, Google Cloud Storage, FTP, Aspera, etc.
  • the bucket or directory name
  • the access credentials, keys or IAM role

All examples in this section use YOUR_STORE_ID as a placeholder which must be replaced with a real value for actual API requests.

To get a store ID, click on your user name and select Manage Stores. The ID for each existing store is displayed in the list. The ID is also visible in the address bar when creating or editing a store, for example:

https://cloud.telestream.net/console/stores/7168a51dd3b8ccb17c9a6ae9473314f3/edit

Did this page help you?