Get the details for a specific live stream instance

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found

Examples

 REQUEST
 GET /v1/organizations/15/live/153
 Content-Type: application/json


 RESPONSE
 200
 {
   "stream_details":{
     "stream_id":101,
     "recurring":true,
     "created_at":1616772268,
     "updated_at":1616772268
   },
   "instance_details":{
     "stream_instance_id":153,
     "dvr_enabled":true,
     "ingest_url":"rtmp://guzzler.vidyard.com:1935/live",
     "stream_key":"fccc320ee3da4exxee5495ba60460ba3",
     "email":null,
     "segment_length":1,
     "has_redundant_streams":true,
     "backup_url":"rtmp://guzzler.vidyard.com:1935/live",
     "backup_key":"159396036xx1c2af70fc53831139bf33",
     "air_date":1616772226,
     "start_time":0,
     "end_time":0,
     "vod_created_at":1616772268,
     "created_at":1616772268,
     "updated_at":1616772268,
     "name":"Recounting VBot's Birthday Bash",
     "description":"Join us for a live recounting of VBot's birthday bash!",
     "tags":[
       ["BirthdayTag", "VBot"],
     ],
     "video_id":350,
     "status":"unaired",
     "player_uuid":"yNpg4xEhtqcrfb3GSBHfxx"
   }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String