Retrieve a live entity

Retrieves the details of an existing Live Entity. The entity’s id that was returned upon entity creation is required for identifying the exact live entity to be retrieved.

/v1/live-entities/:id

GET https://api.uiza.io/api-live/owner/v1/live-entities/:id

Path Parameters

Name	Type	Description
id	string	The identifier of your live entity to be retrieved

200 Live entity successfully retrieved.

{
  "data": {
    "id": "22013d8a-d5fa-48f0-9a63-1f471ca9e81d",
    "name": "Demo app 1",
    "description": "Demo application for documentation",
    "dvr": true,
    "encoding_template": "hd",
    "ingest": {
      "url": "rtmp://f45dd07a0e-in.uizadev.io/transcode",
      "key": "live_TB62vHgxSY"
    },
    "playback": {
      "hls": "https://f45dd07a0e.uizadev.io/fmp4/22013d8a-d5fa-48f0-9a63-1f471ca9e81d/master.m3u8",
      "dash": "https://f45dd07a0e.uizadev.io/fmp4/22013d8a-d5fa-48f0-9a63-1f471ca9e81d/manifest.mpd"
    },
    "region": "in-mumbai-1",
    "relay": [
      {
        "id": "8cf47749-1fa4-40e9-8303-580b34f14683",
        "name": "Replay name3333",
        "url": "rtmp://a.rtmp.youtube.com/live2",
        "key": "0df3-76bz-6t4r-1by5xxxxxx",
        "status": "enable",
        "created_at": "2020-06-24T16:25:58Z",
        "updated_at": "2020-06-24T16:25:58Z"
      }
    ],
    "status": "ready",
    "created_at": "2020-03-10T03:20:37.202Z",
    "updated_at": "2020-03-10T03:20:37.202Z"
  }
}

401

{
  "message": "You are unauthorized to access the requested resource. Please verify and resubmit.",
  "error_type": "invalid_request_error"
}

404

{
  "message": "The live entity you requested does not exist.",
  "error_type": "invalid_request_error"
}

500

{
  "message": "An unexpected error occurred on Uiza's end.",
  "error_type": "api_error"
}

Sample Request

curl -X GET https://api.uiza.io/api-live/owner/v1/live-entities/22013d8a-d5fa-48f0-9a63-1f471ca9e81d 
    -H 'Accept: */*' 
    -H 'Authorization: <token>' 
    -H 'uiza-app-id: <your_app_id>' 
    -H 'Cache-Control: no-cache' 
    -H 'Connection: keep-alive'