Live REST API Reference

Channels

Channels for the current login provider.

/channels get post

get

Use this route to get all channels for the current login provider.

post

Use this route to create a specified channel. See also the domains and contact endpoint.

Use this route to get all channels for the current login provider.

Response

HTTP status code 200

Body

Type: application/json

Example:

{
   "items":[
      {
         "id":"<%channelId%>",
         "name":"<%channelName%>",
         "description":"<%channelDescription%>",
         "provider_id":"<%providerId%>",
         "channel_type":"24x7",
         "status":"Setting Up",
         "resolution":"hd",
         "target_device":"both"
      },
      {
         "id":"<%channelId%>",
         "name":"<%channelName%>",
         "description":"<%channelDescription%>",
         "provider_id":"<%providerId%>",
         "channel_type":"24x7",
         "status":"Setting Up",
         "resolution":"hd",
         "target_device":"both"
      },
      {
         "id":"<%channelId%>",
         "name":"<%channelName%>",
         "description":"<%channelDescription%>",
         "provider_id":"<%providerId%>",
         "channel_type":"24x7",
         "status":"Setting Up",
         "resolution":"hd",
         "target_device":"both"
      }
   ]
}

Use this route to create a specified channel. See also the domains and contact endpoint.

Request
Response

Body

Type: application/json

Example:

//Elemental Encoding and Elemental Packaging
{
   "status":"Setting Up",
   "resolution":"hd",
   "channelType":"24x7",
   "input":{
      "package":{
         "partner":"elemental-delta",
         "elementalDelta":{
            "inputProfile":"<%profileId%>",
            "outputProfile":"<%profileId%>",
            "credentialsId":"<%credentialsId%>",
            "clientId":"<%credentialProfileKey%>",
            "dvrSettings":"Enabled",
            "dvrWindow":"30"
         }
      },
      "encode":{
         "partner":"elemental",
         "elemental":{
            "credentialsId":"<%credentialsId%>",
            "outputProfile":"<%profileId%>",
            "inputProfile":"<%profileId%>",
            "clientId":"<%credentialProfileKey%>",
            "inputs":[
               {
                  "type":"network_input",
                  "mode":"push",
                  "isS3File":false,
                  "order":"0",
                  "streamingProtocol": "RTMP"
               }
            ]
         }
      },
      "serviceNeeded":"encoding, packaging"
   },
   "name":"<%channelName%>",
   "description":"<%channelDescription%>"
}
//Akamai Packaging Only
{
   "status":"Setting Up",
   "resolution":"hd",
   "channelType":"24x7",
   "input":{
      "package":{
         "akamai":{
            "clientId":"<%clientId%>",
            "hostname":"<%hostName%>",
            "reportingCpCode":"<%cpCode%>",
            "configurationType":"<%configType%>",
            "configurationName":"<%configName%>",
            "streamType":"<%stremType%>",
            "password":"<%ingestPassword%>",
            "primaryContact":"<%ContactName%>",
            "secondaryContact":"<%ContactName%>",
            "primaryEncoder":"<%customerEncoderIp%>",
            "secondaryEncoder":"<%customerEncoderIp%>",
            "dvrSettings":"Enabled",
            "dvrWindow":"30"
         },
         "partner":"akamai"
      },
      "serviceNeeded":"packaging"
   },
   "name":"<%channelName%>",
   "description":"<%channelDescription%>"
}
//Elemental Encoding and Akamai Packaging
{
   "status":"Setting Up",
   "resolution":"hd",
   "channelType":"24x7",
   "input":{
      "package":{
         "akamai":{
            "clientId":"<%clientId%>",
            "hostname":"<%hostName%>",
            "reportingCpCode":"<%cpCode%>",
            "configurationType":"<%configType%>",
            "configurationName":"<%configName%>",
            "streamType":"<%stremType%>",
            "password":"<%ingestPassword%>",
            "primaryContact":"<%ContactName%>",
            "secondaryContact":"<%ContactName%>",
            "primaryEncoder":"<%customerEncoderIp%>",
            "secondaryEncoder":"<%customerEncoderIp%>",
            "dvrSettings":"Enabled",
            "dvrWindow":"30"
         },
         "partner":"akamai"
      },
       "encode":{
         "partner":"elemental",
         "elemental":{
            "credentialsId":"<%credentialsId%>",
            "outputProfile":"<%profileId%>",
            "inputProfile":"<%profileId%>",
            "clientId":"<%credentialProfileKey%>",
            "inputs":[
               {
                  "type":"network_input",
                  "mode":"push",
                  "isS3File":false,
                  "order":"0"
               }
            ]
         }
      },
      "serviceNeeded":"packaging"
   },
   "name":"<%channelName%>",
   "description":"<%channelDescription%>"
}
//Azure Encoding and Azure Packaging
{
   "status":"Setting Up",
   "resolution":"hd",
   "channelType":"24x7",
   "input":{
      "package":{
         "partner":"azure",
         "azure":{
            "fMp4FragmentDuration":2,
            "fragmentsPerHlsSegment":3,
            "clientId":"<%credentialProfileKey%>",
            "contentProtection":"false",
            "dvrWindow":1800
         },
         "sourceType":"rtmp"
      },
      "encode":{
         "partner":"azure",
         "azure":{
            "encodingType":"Standard",
            "adMarkerSource":"API",
            "ignoreCea708ClosedCaptions":false,
            "systemPreset":"Default720p",
            "slatePath":""
         }
      },
      "serviceNeeded":"encoding, packaging"
   },
   "name":"<%channelName%>",
   "description":"<%channelDescription%>"
}
//Azure Packaging (Passthrough Encoding)
{
   "status":"Setting Up",
   "resolution":"hd",
   "channelType":"24x7",
   "input":{
      "package":{
         "partner":"azure",
         "azure":{
            "fMp4FragmentDuration":2,
            "fragmentsPerHlsSegment":3,
            "clientId":"<%credentialProfileKey%>",
            "contentProtection":"false",
            "dvrWindow":1800
         },
         "sourceType":"rtmp"
      },
      "serviceNeeded":"packaging"
   },
   "name":"<%channelName%>",
   "description":"<%channelDescription%>"
}

HTTP status code 201

Body

Type: application/json

Example:

{
   "id":"<%channelId%>",
   "name":"<%channelName%>",
   "description":"<%channelDescription%>",
   "provider_id":"<%providerId%>",
   "channel_type":"24x7",
   "status":"Setting Up",
   "resolution":"hd",
   "target_device":"both"
}
/channels/:id?include=input
{
   "id":"<%channelId%>",
   "name":"<%channelName%>",
   "description":"<%channelDescription%>",
   "provider_id":"<%providerId%>",
   "channel_type":"24x7",
   "status":"Setting Up",
   "resolution":"hd",
   "target_device":"both",
   "input":{
      "serviceNeeded":"encoding, packaging",
      "package":{
         "partner":"elemental-delta",
         "sourceType":"",
         "elementalDelta":{
            "clientId":"<%clientId%>",
            "credentialsId":"<%credentialsId%>",
            "outputProfile":"<%profileId%>",
            "inputProfile":"<%profileId%>",
            "dvrSettings":"Enabled",
            "dvrWindow":"30",
            "location":"<%deploymentLocation%>"
         },
         "ooPlayer":"https://player.ooyala.com/v3/<%playerId%>"
      },
      "encode":{
         "partner":"elemental",
         "elemental":{
            "clientId":"<%clientId%>",
            "credentialsId":"<%credentialsId%>",
            "outputProfile":"<%profileId%>",
            "inputProfile":"<%profileId%>",
            "inputs":[
               {
                  "order":"0",
                  "type":"network_input",
                  "mode":"push",
                  "uri":"rtmp://<%channelId%>.live-entry.ooyala.com/live/<%channelId%>",
                  "isS3File":false,
                  "inputUrl":"rtmp://<%channelId%>.live-entry.ooyala.com/live/<%channelId%>",
                  "previewUrl":"",
                  "streamingProtocol": "RTMP"
               }
            ],
            "location":"<%deploymentLocation%>",
            "elementalId":"<%eventId%>"
         }
      }
   }
}

/channels/{id} get delete

get

Use this route to get the channel matching the specified ID.

delete

Use this route to delete the channel matching the specified ID.

Use this route to get the channel matching the specified ID.

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
   "id":"<%channelId%>",
   "name":"<%channelName%>",
   "description":"<%channelDescription%>",
   "provider_id":"<%providerId%>",
   "channel_type":"24x7",
   "status":"Setting Up",
   "resolution":"hd",
   "target_device":"both"
}

Use this route to delete the channel matching the specified ID.

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
   "statusCode":200,
   "message":"Deleting",
   "session":"<%sessionId%>"
}

/channels/{id}/start post

Use this route to move the specified channel to the running state and ready for ingestion.

post

Channel start request and response.

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

HTTP status code 200

Body

Type: application/json

Example:

{
   "statusCode":200,
   "message":"Starting",
   "session":"<%sessionId%>"
}

/channels/{id}/start_stream/{partner} post

Use this route to start a syndicated stream to a Facebook, Periscope, or Twitch.

post

Start a syndicated stream for a given channel to a given partner, which can be Facebook, Periscope, or Twitch.

• id is the ID of the channel for which you wish to start a syndicated stream.

• partner is the partner you wish to stream to. Valid values are facebook, periscope, and twitch.

If an unidentified partner value is passed in, a 400 response (bad request) will be returned. If the syndicated stream is already live when starting, a 409 response (conflict) will be returned.

A JSON request body containing a user_access_token string parameter is required when starting a Facebook stream. The request body may also contain title and description string parameters, but these are optional. The title and description will default to the name and description of the channel, respectively.

Facebook user access tokens can be generated at https://developers.facebook.com/tools/explorer/. More information about user access tokens can be found here.

Request bodies are not required for start-stream requests to partners other than Facebook. An example start-stream request to Facebook is presented below.

Start a syndicated stream for a given channel to a given partner, which can be Facebook, Periscope, or Twitch.

• id is the ID of the channel for which you wish to start a syndicated stream.

• partner is the partner you wish to stream to. Valid values are facebook, periscope, and twitch.

If an unidentified partner value is passed in, a 400 response (bad request) will be returned. If the syndicated stream is already live when starting, a 409 response (conflict) will be returned.

Facebook user access tokens can be generated at https://developers.facebook.com/tools/explorer/. More information about user access tokens can be found here.

Request bodies are not required for start-stream requests to partners other than Facebook. An example start-stream request to Facebook is presented below.

Request
Response

URI Parameters

id: required (string)
partner: required (string)

Body

Type: application/json

Example:

{
    "user_access_token": "Access token to the FB account to which streaming will take place.",
    "title": "Title of Video to Appear on FB",
    "description": "Description of video to appear on FB."
}

HTTP status code 200

An example response for a request to start streaming to Periscope is illustrated below.

Body

Type: application/json

Example:

{
  "statusCode": 200,
  "message": "Periscope/Twitter stream is starting",
  "session": "5fba570b-5442-4988-8651-53215898cc88"
}

/channels/{id}/pause_stream/{partner} post

Use this route to stop a syndicated stream to a Facebook, Periscope, or Twitch.

post

Stop a syndicated stream for a given channel to a given partner, which can be Facebook, Periscope, or Twitch.

• id is the ID of the channel for which you wish to stop a syndicated stream.

• partner is the partner you wish to stream to. Valid values are facebook, periscope, and twitch.

If an unidentified partner value is passed in, a 400 response (bad request) will be returned. If the syndicated stream is already inactive when stopping, a 409 response (conflict) will be returned.

No request body is required for a request to stop a stream to a partner.

Stop a syndicated stream for a given channel to a given partner, which can be Facebook, Periscope, or Twitch.

• id is the ID of the channel for which you wish to stop a syndicated stream.

• partner is the partner you wish to stream to. Valid values are facebook, periscope, and twitch.

No request body is required for a request to stop a stream to a partner.

Request
Response

URI Parameters

id: required (string)
partner: required (string)

HTTP status code 200

An example response for a request to stop streaming to Periscope is illustrated below.

Body

Type: application/json

Example:

{
  "statusCode": 200,
  "message": "Periscope/Twitter stream is stopping",
  "session": "7c37a385-2c55-4513-9259-14aafdc159e1"
}

/channels/{id}/stop post

Use this route to move the specified channel to the stopped state and stop live streaming.

post

Channel stop request and response.

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

HTTP status code 200

Body

Type: application/json

Example:

{
   "statusCode":200,
   "message":"Stopping",
   "session":"<%sessionId%>"
}

/channels/{id}/cancel post

Use this route to put the specified channel in the error state and cancel all running workflows.

post

Channel cancel request and response.

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

HTTP status code 200

Body

Type: application/json

Example:

{
   "statusCode":200,
   "message":"Forced to Error state",
   "session":"<%sessionId%>"
}

Provider Credentials

Credentials currently assigned to the customer.

/provider_creds get

get

Use this route to get a list of credentials currently assigned to the customer.

Response

HTTP status code 200

Body

Type: application/json

Example:

{
   "items":[
      {
         "id":"<%credentialsId%>",
         "name":"akamai_packaging",
         "profile_type":"credentials",
         "profiles":[
            "<%clientId%>",
            "<%clientId%>"
         ],
         "partner_id":"17bd012c53fb4df99fd2555350f02be1",
         "is_private":1
      },
      {
         "id":"<%credentialsId%>",
         "name":"elemental-delta_packaging",
         "profile_type":"credentials",
         "profiles":[
            "<%clientId%>"
         ],
         "partner_id":"ea6a3dfe43c249d8af3a27756c4a1770",
         "is_private":1
      },
      {
         "id":"<%credentialsId%>",
         "name":"elemental-live_encoding",
         "profile_type":"credentials",
         "profiles":[
            "<%clientId%>",
            "<%clientId%>",
            "<%clientId%>",
            "<%clientId%>",
            "<%clientId%>"
         ],
         "partner_id":"4e60fadf90d74ca3a3ae2326f9ecc922",
         "is_private":1
      }
   ]
}

/provider_creds/{id} get

Use this route to get the credentials, matching the specified ID, that are currently assigned to the customer.

get

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
   "id":"<%credentialsId%>",
   "name":"elemental-delta_packaging",
   "profile_type":"credentials",
   "profiles":[
      "<%clientId%>"
   ],
   "partner_id":"ea6a3dfe43c249d8af3a27756c4a1770",
   "is_private":1
}

Provider Profiles

Profiles currently assigned to the customer.

/provider_profiles get

get

Use this route to get a list of profiles currently assigned to the customer.

Response

HTTP status code 200

Body

Type: application/json

Example:

{
   "items":[
      {
         "id":"<%profileId%>",
         "name":"Delta_input",
         "profile_type":"packaging",
         "partner_id":"ea6a3dfe43c249d8af3a27756c4a1770",
         "is_private":1,
         "is_template":1,
         "profile_hash":"f0044f8a8ed0402e4d6238f582dd3b89"
      },
      {
         "id":"<%profileId%>",
         "name":"Delta_output",
         "profile_type":"packaging",
         "partner_id":"ea6a3dfe43c249d8af3a27756c4a1770",
         "is_private":1,
         "is_template":2,
         "profile_hash":"8445924517b0c666cc592669b51950b7"
      },
      {
         "id":"<%profileId%>",
         "name":"Elemental Live File Input",
         "profile_type":"encoding",
         "partner_id":"4e60fadf90d74ca3a3ae2326f9ecc922",
         "is_private":1,
         "is_template":1,
         "profile_hash":"a9b70d5d7f7d62795aba6b796025efb4"
      },
      {
         "id":"<%profileId%>",
         "name":"ELEMENTAL Output 1",
         "profile_type":"encoding",
         "partner_id":"4e60fadf90d74ca3a3ae2326f9ecc922",
         "is_private":1,
         "is_template":2,
         "profile_hash":"27cb4de3460bd4ae66375120189aab67"
      }
   ]
}
/provider_profiles?include=meta
{
   "items":[
      {
         "id":"<%profileId%>",
         "name":"Delta_input",
         "profile_type":"packaging",
         "partner_id":"ea6a3dfe43c249d8af3a27756c4a1770",
         "is_private":1,
         "is_template":1,
         "meta":{
            "type":"input",
            "count":1,
            "input_desc":[
               {
                  "type":"webdav"
               }
            ]
         },
         "profile_hash":"f0044f8a8ed0402e4d6238f582dd3b89"
      },
      {
         "id":"<%profileId%>",
         "name":"Delta_output",
         "profile_type":"packaging",
         "partner_id":"ea6a3dfe43c249d8af3a27756c4a1770",
         "is_private":1,
         "is_template":2,
         "meta":{
            "type":"output",
            "count":3,
            "output_desc":[
               {
                  "name":"filter_3",
                  "type":"hds"
               },
               {
                  "name":"filter_2",
                  "type":"dash"
               },
               {
                  "name":"filter_4",
                  "type":"hls"
               }
            ]
         },
         "profile_hash":"8445924517b0c666cc592669b51950b7"
      },
      {
         "id":"<%profileId%>",
         "name":"Elemental Live Input",
         "profile_type":"encoding",
         "partner_id":"4e60fadf90d74ca3a3ae2326f9ecc922",
         "is_private":1,
         "is_template":1,
         "meta":{
            "type":"input",
            "count":1,
            "input_desc":[
               {
                  "name":"input_1",
                  "order":1,
                  "type":"network",
                  "input_label":"RTMP Input (Customer-Akamai)"
               }
            ]
         },
         "profile_hash":"a9b70d5d7f7d62795aba6b796025efb4"
      },
      {
         "id":"<%profileId%>",
         "name":"ELEMENTAL Output 1",
         "profile_type":"encoding",
         "partner_id":"4e60fadf90d74ca3a3ae2326f9ecc922",
         "is_private":1,
         "is_template":2,
         "meta":{
            "type":"output",
            "count":1,
            "output_desc":[
               {
                  "order":1,
                  "type":"rtmp",
                  "stream_count":5
               }
            ]
         },
         "profile_hash":"27cb4de3460bd4ae66375120189aab67"
      }
   ]
}

Domains and Contact

Domains and contact for a specified credential ID. This information is required for channel creation.

/akamai_meta/{id} get

get

Use this route to get a list of domains and contact for the specified credential ID. This information is required for channel creation.

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
   "items":[
      {
         "domains":[
            {
               "display":"test-lh.akamaihd.net (000000)",
               "value":"test-lh",
               "hostname":"test-lh.akamaihd.net",
               "configurationName":"test-lh",
               "configurationType":"Universal Streaming Live",
               "streamType":"Universal Streaming Live",
               "reportingCpCode":"000000",
               "isSecure":true,
               "isReflector":false,
               "input":"RTMP",
               "output":"HLS,HDS"
            }
         ],
         "contacts":[
            {
               "display":"Responsible Contact",
               "value":"Name LastName",
               "name":"Name LastName"
            }
         ],
         "profile_key":"<%clientId%>"
      },
      {
         "domains":[
            {
               "display":"test2-lh.akamaihd.net (000001)",
               "value":"test2-lh",
               "hostname":"test2-lh.akamaihd.net",
               "configurationName":"test2-lh",
               "configurationType":"Universal Streaming Live",
               "streamType":"Universal Streaming Live",
               "reportingCpCode":"000001",
               "isSecure":true,
               "isReflector":false,
               "input":"RTMP",
               "output":"HLS,HDS"
            }
         ],
          "contacts":[
            {
               "display":"Responsible Contact",
               "value":"Name LastName",
               "name":"Name LastName"
            }
         ],
         "profile_key":"<%clientId%>"
      }
   ]
}

Schedules

Schedules for the current login provider.

/schedules get post

get

Use this route to get all schedules for the current login provider.

post

Use this route to create a schedule for the channel.

Use this route to get all schedules for the current login provider.

Response

HTTP status code 200

Body

Type: application/json

Example:

{
   "items":[
      {
         "id":"<%schduleId%>",
         "name":"<%scheduleName%>",
         "live_stream_asset_id":"<%embedCode%>"
      },
      {
         "id":"<%schduleId%>",
         "name":"<%scheduleName%>",
         "live_stream_asset_id":"<%embedCode%>"
      },
      {
         "id":"<%schduleId%>",
         "name":"<%scheduleName%>",
         "live_stream_asset_id":"<%embedCode%>"
      }
   ]
}

Use this route to create a schedule for the channel.

Request
Response

Body

Type: application/json

Example:

{
   "channel_id":"<%channel_id%>",
   "live_stream_asset_id":"<%embedCode%>",
   "name":"<%scheduleName%>"
}

HTTP status code 201

Body

Type: application/json

Example:

{
   "id":"<%channelId%>",
   "name":"<%channelName%>",
   "description":"<%channelDescription%>",
   "provider_id":"<%providerId%>",
   "channel_type":"24x7",
   "status":"Setting Up",
   "resolution":"hd",
   "target_device":"both"
}
/channels/:id?include=input
{
   "id":"<%channelId%>",
   "name":"<%channelName%>",
   "description":"<%channelDescription%>",
   "provider_id":"<%providerId%>",
   "channel_type":"24x7",
   "status":"Setting Up",
   "resolution":"hd",
   "target_device":"both",
   "input":{
      "serviceNeeded":"encoding, packaging",
      "package":{
         "partner":"elemental-delta",
         "sourceType":"",
         "elementalDelta":{
            "clientId":"<%clientId%>",
            "credentialsId":"<%credentialsId%>",
            "outputProfile":"<%profileId%>",
            "inputProfile":"<%profileId%>",
            "dvrSettings":"Enabled",
            "dvrWindow":"30",
            "location":"<%deploymentLocation%>"
         },
         "ooPlayer":"https://player.ooyala.com/v3/<%playerId%>"
      },
      "encode":{
         "partner":"elemental",
         "elemental":{
            "clientId":"<%clientId%>",
            "credentialsId":"<%credentialsId%>",
            "outputProfile":"<%profileId%>",
            "inputProfile":"<%profileId%>",
            "inputs":[
               {
                  "order":"0",
                  "type":"network_input",
                  "mode":"push",
                  "uri":"rtmp://<%channelId%>.live-entry.ooyala.com/live/<%channelId%>",
                  "isS3File":false,
                  "inputUrl":"rtmp://<%channelId%>.live-entry.ooyala.com/live/<%channelId%>",
                  "previewUrl":"",
                  "streamingProtocol": "RTMP"
               }
            ],
            "location":"<%deploymentLocation%>",
            "elementalId":"<%eventId%>"
         }
      }
   }
}

/schedules/{id} get patch delete

get

Use this route to get the schedule matching the specified ID.

patch

Use this route to update the specified schedule. If the channel ID is updated, the new channel will be associated with the updated schedule.

delete

Use this route to delete the schedule matching the specified ID. First, all events associated with the schedule will be deleted, then the schedule itself will be deleted.

Use this route to get the schedule matching the specified ID.

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
   "id":"<%schduleId%>",
   "name":"<%scheduleName%>",
   "live_stream_asset_id":"<%embedCode%>"
}

Use this route to update the specified schedule. If the channel ID is updated, the new channel will be associated with the updated schedule.

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Example:

{
   "id":"<%schduleId%>",
   "name":"<%scheduleName%>",
   "live_stream_asset_id":"<%embedCode%>"
}

HTTP status code 200

Body

Type: application/json

Example:

{
   "id":"<%channelId%>",
   "name":"<%channelName%>",
   "description":"<%channelDescription%>",
   "provider_id":"<%providerId%>",
   "channel_type":"24x7",
   "status":"Setting Up",
   "resolution":"hd",
   "target_device":"both"
}

Use this route to delete the schedule matching the specified ID. First, all events associated with the schedule will be deleted, then the schedule itself will be deleted.

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
   "statusCode":200,
   "message":"Schedule Deleted",
   "session":"<%sessionId%>"
}

Events

Events include all data bindings between schedule and channel and program, as well as scheduled auto-start and auto-stop, if specified.

/events post

post

Creates an event, including all data bindings between schedule and channel and program, as well as scheduled auto-start and auto-stop, if specified. This method also starts a workflow that provisions the event and makes it ready to use. After the event is ready its status will be "Stopped".

Request
Response

Body

Type: application/json

Example:

{
   "name":"<%eventName%>",
   "description":"<%eventDescription%>",
   "image_height":"150",
   "image_width":"250",
   "track_id":"<%scheduleId%>",
   "status":"offline",
   "override_channel_id":"<%channelId%>",
   "start_time":"<%startTime%>",
   "end_time":"<%stopTime%>",
   "virtual_asset":{
      "name":"<%eventName%>",
      "metadata":{
         "channel_id":"<%channelId%>",
         "archive":"1",
         "trim":"0",
         "override":"0",
         "dvrwindow":"3720",
         "autostart_minutes":"1",
         "autostop_minutes":"1"
      }
   }
}

HTTP status code 201

Body

Type: application/json

Example:

{
   "id":"<%eventId%>",
   "name":"<%eventName%>",
   "description":"<%eventDescription%>",
   "image_height":"150",
   "image_width":"250",
   "track_id":"<%scheduleId%>",
   "status":"offline",
   "override_channel_id":"<%channelId%>",
   "start_time":"<%startTime%>",
   "end_time":"<%stopTime%>",
   "virtual_asset":{
      "name":"<%eventName%>",
      "metadata":{
         "channel_id":"<%channelId%>",
         "archive":"1",
         "trim":"0",
         "override":"0",
         "dvrwindow":"3720",
         "autostart_minutes":"0",
         "autostop_minutes":"0"
      }
   }
}

/events/{id}/start post

post

Initiates the workflow that starts the specified event if the channel for the event is in a running state.

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Example:

/events:id/start

HTTP status code 200

Body

Type: application/json

Example:

{
   "statusCode":200,
   "message":"Starting",
   "session":"<%sessionId%>"
}

/events/{id}/stop post

post

Initiates the workflow that stops the specified event.

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Example:

/events:id/stop

HTTP status code 200

Body

Type: application/json

Example:

{
   "statusCode":200,
   "message":"Stopping",
   "session":"<%sessionId%>"
}

/events/{id}/cancel post

post

Specify auto_stop to disable the event from automatically stopping. Specify auto_start to disable the event from automatically starting. If no body is passed or any value other than auto_stop/auto_start is passed in, cancel will stop all related workflows for the event.

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

HTTP status code 200

Body

Type: application/json

Example:

{
   "statusCode":200,
   "message":"Forced to Error state",
   "session":"<%sessionId%>"
}

/events/{id}/trim post

post

Trims the event asset based on the specified start and duration.

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Example:

{
   "start":<%int64%>,
   "duration":<%int64%>
}

HTTP status code 200

Body

Type: application/json

Example:

{
   "statusCode":200,
   "message":"Trimming",
   "session":"<%sessionId%>"
}

Live REST API Reference

version v3

Introduction

Channels

/channels get post

/channels/{id} get delete

/channels/{id}/start post

/channels/{id}/start_stream/{partner} post

/channels/{id}/pause_stream/{partner} post

/channels/{id}/stop post

/channels/{id}/cancel post

Provider Credentials

/provider_creds get

/provider_creds/{id} get

Provider Profiles

/provider_profiles get

Domains and Contact

/akamai_meta/{id} get

Schedules

/schedules get post

/schedules/{id} get patch delete

Events

/events post

/events/{id}/start post

/events/{id}/stop post

/events/{id}/cancel post

/events/{id}/trim post

Live REST API Reference

version v3

Channels

get /channels

HTTP status code 200

Body

post /channels

Body

HTTP status code 201

Body

get /channels/{id}

URI Parameters

HTTP status code 200

Body

delete /channels/{id}

URI Parameters

HTTP status code 200

Body

post /channels/{id}/start

URI Parameters

Body

HTTP status code 200

Body

post /channels/{id}/start_stream/{partner}

URI Parameters

Body

HTTP status code 200

Body

post /channels/{id}/pause_stream/{partner}

URI Parameters

HTTP status code 200

Body

post /channels/{id}/stop

URI Parameters

Body

HTTP status code 200

Body

post /channels/{id}/cancel

URI Parameters

Body

HTTP status code 200

Body

Provider Credentials

get /provider_creds

HTTP status code 200

Body

get /provider_creds/{id}

URI Parameters

HTTP status code 200

Body

Provider Profiles

get /provider_profiles

HTTP status code 200

Body

Domains and Contact

get /akamai_meta/{id}

URI Parameters

HTTP status code 200

Body

Schedules

get /schedules

HTTP status code 200

Body

post /schedules

Body

HTTP status code 201

Body

get /schedules/{id}

URI Parameters

HTTP status code 200

Body

patch /schedules/{id}

URI Parameters

Body

HTTP status code 200

Body

delete /schedules/{id}

URI Parameters

HTTP status code 200

Body