Identifying the Desired Telestream Cloud Store

The first API method discussed shall be a call to retrieve a list of STORES defined for a given account. The list of Stores represents the locations which may be specified for any action which advertises a Storage option.

As a reference, recall from the previous section that when the ‘API Example’ workflow was imported into Telestream Cloud, the following appears in the DETAILS panel of this workflow:

This implies that the action: ‘IPTV Flip’ has a reference to a Storage. This implies that a Cloud Store must be specified when a job is submitted to this workflow.

🚧

Provider and Region

This is extremely important as the specification of the Cloud Store DEFINES the provider and region where the container instance which shall process this particular action is spun up. For example, you specify a Store located in S3 in the US East 1 Region, this is where the instance for the associated job shall be hosted and run.

It is highly recommended that the source of the job and the output store for a job reside in the same Provider/Region; this will negate/minimize any EGRESS costs which would otherwise be incurred.

The following call will display the Cloud Stores which have been defined for the account for which the API Key utilized in the request.

https://api.cloud.telestream.net/stores/v1.1/stores

The result of the /stores call shall be an array of JSON objects which adhere to the structure:

{

        "id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        "name": "EEEEEEEEEEEEEEEEE",
        "provider": "S3",
        "account_id": "BBBBBBBBBBBBBBBBBBBBBBBBBBB",
        "bucket_name": "CCCCCCCCCCCCCCCCCCCCC",
        "region": "DDDDDDDDDDDDDDDDDD",
        "private_access": false,
        "provider_specific_settings": {},
        "input_store": false,
        "created_at": "2019-02-11T15:18:54Z",
        "updated_at": "2019-02-11T15:18:54Z"
    }

NOTE: Certain fields have been obscured by LETTERS above for obvious reasons.

This query shall list the stores available in this account. The id of a store which is desired for use in a job triggered by the API should be retained.

IE: If you wish to submit a job and have the action(s) within that job utilize the store above, you would store the value: "id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAA" and then make use of this in subsequent SUBMIT calls.