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
id
string
The identifier of the live entity to be updated.
Request Body
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. The status
of a relay can be enabled
or disabled
.
Last updated