Media Services Live Stream Provisioning API Data

This section provides you with the data model for the Media Services Live Stream Provisioning API.

The data schema tables below list membership requirements as follows:

Member is required to be present, regardless of whether the value is empty or null.
Member is optional, and may be omitted in some cases.

Download the JSON schemas for this API.

Stream

Encapsulates stream configuration and version information. You can list, create, edit, delete, and get details of streams.

Download schema: StreamDTO.json

Sample GET:

{
    "id": 654345,
    "name": "DemoStream",
    "format": "HLS",
    "cpcode": 123321,
    "ingestAccelerated": false,
    "dvrWindow": 5,
    "allowedIps": [],
    "encoderZone": "EUROPE",
    "backupEncoderZone": "EUROPE",
    "origin": {
        "hostName": "demo-host1.akamaiorigin.net"
    },
    "backupOrigin": {
        "hostName": "demo-host2.akamaiorigin.net"
    },
    "events": [],
    "createdDate": "2017-11-14T07:06:25.794Z",
    "modifiedDate": "2017-11-14T07:20:12.359Z",
    "createdBy": "abc",
    "modifiedBy": "def",
    "provisionDetail": {
        "streamId": 235235,
        "status": "PENDING"
    },
    "additionalEmailIds": [
        "abc@akamai.com"
    ],
    "storageGroup": {
        "cpcode": 125334
    },
    "backupStorageGroup": {
        "cpcode": 124
    },
    "primaryPublishingUrl": "test1.akamaientrypoint.net",
    "backupPublishingUrl": "test2.akamaientrypoint.net",
    "isDedicatedOrigin": false
}

Stream Members

Member Type Required Description
backupStorageCpcode Integer Specify the Media Services Live CP code for the backup storage.
cpcode Integer CP code resources enable you to specify the Content Provider code associated with the stream. A Content Provider code is necessary to track all web traffic handled by Akamai servers. It is supplied to you when you purchase a product, and you need it to activate any associated properties. You can generate additional CP codes, typically to implement more detailed billing and reporting functions and assign to custom properties.
createdBy String Specify the user name of the user who created the stream.
createdDate String Specifies the date on which the stream was created.
dvrWindowInMin Integer Specify a DVR Window value from 5 to 30 minutes. DVR Window is the length of time that content is available as DVR content.
encoderZone String Specify the encoder’s geographical location. Choose an encoder that is close to your location.
format Enumeration The ingest format for Apple HTTP Live Streaming (HLS), Adobe HTTP Dynamic Streaming (HDS), Dynamic Adaptive Streaming over HTTP (DASH), or Common Media Application Format (CMAF). Enum values: CMAF, DASH, HDS, HLS.
id Integer Specify the stream ID. The stream ID must be identical between your primary and backup streams. The stream ID can be obtained from the Luna Control Center’s Manage HD Live Streams and Stream Details pages.
modifiedBy String Specify the user name of the user who edited the stream.
modifiedDate String Specify the date on which the stream is modified.
name String Specify a name for your stream. Your stream name can be up to 90 characters in length and can include the characters a-z, A-Z, 0–9, underscores ( _ ), and hyphens ( - ).
originHostName String Specify the origin hostname. This depends on the CDN that you use. For Akamai CDN, the hostname is origin.akamaized.net (AMD hostname).
primaryStorageCpcode Integer Specify the Media Services Live CP code for the primary storage.
provisionDetail Stream.provisionDetail Provides details about the stream provisioning status.

Stream.provisionDetail  

Provides details about the stream provisioning status.

Member Type Required Description
message String Specify a message about the stream status.
status Enumeration The status of the stream. Possible enum values are: PENDING, PROVISIONED, FAILED
streamId Integer A unique ID for your stream.

Origin

Encapsulates configuration and versions for an origin. You can list, create, edit, and get details of origins. You can also create and activate origin versions.

Download schema: OriginDetailsDTO.json

Sample GET:

{
    "id": 68,
    "hostName": "demoHost1.akamaiorigin.net",
    "cpcode": 876213,
    "versions": [
        {
            "additionalHostNames": [],
            "sslEnabled": false,
            "version": 1,
            "active": true,
            "notes": "Initial Version",
            "createdBy": "username",
            "createdDate": "2017-06-12T17:28:19.825Z"
        }
    ],
    "status": "SUCCEEDED"
}

Origin Members

Member Type Required Description
cpcode Integer Specify the origin CP code.
createdDate Integer Specify the date on which the origin is created.
g2oKeys Origin.versions[n].g2oKeys[n] Specify the origin G2O key(s) name and value for multi account origin access. Multi Account Access enables you to allow Media Services Live streams defined in one account to be delivered by delivery configurations in other account(s). This is achieved by using manual access key(s) or G2O keys.
hostName String Specify the origin hostname. The hostname can have up to 16 alphanumeric characters and periods. Only alphabets, numerals and periods (.) are allowed. Do not use any other characters or consecutive periods.
id Integer Specify the origin ID.
notes String Notes about the origin (such as the version).
region String Origin location.
resourceGroup String Identifies logical grouping of resources of similar type that allows the MSL system to leverage or enforce specific behavior (such as mapping preferences for Dedicated Origin).
status String Origin status (such as SUCCEEDED or FAILED).
versions Origin.versions[n] Encapsulates a version for an origin configuration. You can create, activate, and get details of origin versions.

Origin.g2oKeys[n]  

Specify the origin G2O key(s) name and value for multi account origin access. Multi Account Access enables you to allow Media Services Live streams defined in one account to be delivered by delivery configurations in other account(s). This is achieved by using manual access key(s) or G2O keys.

Member Type Required Description
key String Specify the origin G2O key(s).
nonce String Enter a Name (up to 8 alphabets, numbers, or alphanumeric characters) for the G2O key to be generated.

Origin.versions[n]  

Encapsulates a version for an origin configuration. You can create, activate, and get details of origin versions.

Member Type Required Description
active Boolean Specifies whether the origin is active.
additionalHostNames Array A list of additional origin hostnames.
createdBy String Specifies the user name of the person who created the origin.
createdDate String Specifies the date on which the origin was created.
g2oKeys Origin.versions[n].g2oKeys[n] Specify the origin G2O key(s) name and value for multi account origin access. Multi Account Access enables you to allow Media Services Live streams defined in one account to be delivered by delivery configurations in other account(s). This is achieved by using manual access key(s) or G2O keys.
notes String Displays notes about the origin.
sslEnabled Boolean Specifies whether SSL is enabled for the origin.
version Integer Specifies the origin version.

Origin.versions[n].g2oKeys[n]  

Specify the origin G2O key(s) name and value for multi account origin access. Multi Account Access enables you to allow Media Services Live streams defined in one account to be delivered by delivery configurations in other account(s). This is achieved by using manual access key(s) or G2O keys.

Member Type Required Description
key String Specify the origin G2O key(s).
nonce String Enter a Name (up to 8 alphabets, numbers, or alphanumeric characters) for the G2O key to be generated.

PagingAndSorting

Specifies pagnation and sorting of request data.

Download schema: PagingAndSortingDTO.json

Sample GET:

{
    "page": 1,
    "pageSize": 25,
    "sortKey": "name",
    "sortOrder": "ASC"
}

PagingAndSorting Members

Member Type Required Description
page Integer Optionally specifies the number of pages. The default value is 1.
pageSize Integer Indicates the number of data points that are displayed per page. The default is to display all data if you do not specify the page size.
sortKey Enumeration Optionally sorts the fields displayed based on the key that you specify. The default value is the modified date. You can sort based on the following enum values: name, id, format, cpcode, zone, origin_hostname, transcoding_id, status, dvrWindowInMin, createdDate, or modifiedDate.
sortOrder Enumeration Sorts the streams displayed by the order you specify (ASC for ascending or DESC for descending). The default value is DESC.

Last modified: 12/6/2017