Update A Live Entity

Updates a specified live entity's name, description, dvr setting, or relays. Any parameters not provided will be left unchanged.

/v1/live_entities/:id

PATCH https://api.uiza.sh/v1/live_entities/:id

Path Parameters

Name	Type	Description
id	string	The identifier of the live entity to be updated.

Request Body

Name	Type	Description
dvr	boolean	Indicates whether Digital Video Record (DVR) is enabled for the live_entity. Set as true to enable and as false to disable.
name	string	The new name of live entity to be updated. This parameter cannot be empty in your body request.
description	string	The new description of the live entity to be updated. This version does not support update description as an empty string, in case your old description is incorrect, replace it with the new one that makes more sense.
relay	array	The new relay of the live entity to be updated. It must include the object(s) with url, key, and name (optional) attributes, if you want to clear all your relay setting, send relay: [{}] when updating the live entity.

200

{
  "id": "22013d8a-d5fa-48f0-9a63-1f471ca9e81d",
  "name": "Test Event Updated",
  "description": "Event for Test",
  "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"
  },
  "relay": [
    {
      "url": "rtmp://youtu.be/live",
      "key": "Abco1"
    }
  ],
  "preset": null,
  "region": "in-bangalore-1",
  "status": "ready",
  "dvr": false,
  "encode": false,
  "created_at": "2019-12-11T02:47:04Z",
  "updated_at": "2019-12-16T02:53:30Z"
}

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 PATCH https://api.uiza.sh/v1/live_entities/22013d8a-d5fa-48f0-9a63-1f471ca9e81d 
    -H 'Accept: */*' 
    -H 'Authorization: uap-c1ffbff4db954ddcb050c6af0b43ba56-41193b64' 
    -H 'Cache-Control: no-cache' 
    -H 'Connection: keep-alive' 
    -d '{"name": "Test Event Updated", "description": "Event for Test"}'