Skip to main content

Validate Third Party Storage Setup

POST 
https://api.millicast.com/api/v3/account/media/storage/validate

Validates third party storage is configured with permissions for Dolby.io to upload media assets.

To track the validation result, keep note of the the id returned in the response body. If correctly configured, when calling Read Media Asset, the response should return a successful entry with id matching the id.

Run once to validate write permissions. If successful, optionally run a second time to confirm that overwriting is allowed.

Note that validation results are only available for 1 hour.

Request​

Bodyrequired

    profileIdstringnullable

    Optional. Provide the id of a storage profile. Mutually exclusive with Type.

    type objectnullable

    Optional. Use to indicate the storage provider type for a one-off storage configuration. Mutually exclusive with ProfileId. Storage provider type. One of the following:

    • awsS3 - Amazon S3
    • gcs - Google Cloud Storage
    • dolbyStorage - Dolby.io's storage buckets. Call Read Media Asset to retrieve the clip file.
    oneOf
    string

    Possible values: [gcs, awsS3, dolbyStorage]

    options objectnullable

    May be used in the following ways:
    1. Optional. Override parameters of a storage profile specified via ProfileId
    2. Required. Set parameters for a one-off storage configuration when Type is provided
    3. Optional. Override parameters of the default storage profile if neither ProfileId or Type are provided

    oneOf
    objectPrefixstringnullable

    Optional. Prefix to object when stored in bucket i.e. protocol://bucketName/objectPrefix/objectName.ext. Ignored when using Dolby.io's storage buckets. objectName is either defined by a system assigned GUID or the user-specified clipName.

    Possible values: <= 1000 characters

    bucketNamestringnullable

    Name of bucket to upload clips to. Please ensure Dolby.io's service account is granted access.

    bucketRegionstringnullable

    Region of the specified bucket if using storage provider awsS3

    Possible values: non-empty and <= 32 characters

Responses​

Success

Schema
    statusstringrequired

    Possible values: non-empty

    Default value: success
    data objectrequired
    idstringnullable
    storage objectnullable
    oneOf
    type object

    Storage provider type

    oneOf
    string

    Possible values: [gcs, awsS3, dolbyStorage]

    pathstringnullable

    Path to clip storage location. Available only for external storage configurations.

Authorization: http

name: API_Secrettype: httpdescription: ### Usage
#### Acquire secret from dashboard.
* Login to the streaming dashboard
* On the left menu, click on Settings
* Navigate to the Security tab's sub section API Secrets
1. "+ Create" to generate a new named API Secret if needed
2. Click on the copy button or the reveal button to access a previously created API Secret

![](../assets/api_secret.png "Find API Secret")scheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.millicast.com/api/v3/account/media/storage/validate");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"profileId\": \"string\",\n  \"type\": \"gcs\",\n  \"options\": {\n    \"objectPrefix\": \"string\",\n    \"bucketName\": \"string\",\n    \"bucketRegion\": \"string\"\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://api.millicast.com
Auth
Body required
{
  "profileId": "string",
  "type": "gcs",
  "options": {
    "objectPrefix": "string",
    "bucketName": "string",
    "bucketRegion": "string"
  }
}