Uiza Documentation
2020-05-07
2020-05-07
  • Hola! 👋
  • Getting Started
    • Introduction
    • Authentication
    • Errors
    • Quick Starts
      • Live Streaming
      • Video Streaming
    • Pagination
    • Recommended Specifications
    • Postman Collections
    • Sample Streaming Apps
      • NodeJS Live Streaming App
      • Java Live Streaming App
      • Python Live Streaming App
      • How to integrate live streaming into an Android App using Uiza’s Live API
    • Versioning
  • API Reference
    • Live Entities
      • Create A Live Entity
      • Retrieve A Live Entity
      • Update A Live Entity
      • [Deprecated] Update A Live Entity
      • Delete A Live Entity
      • List All Live Entities
      • [Deprecated] Enable Live Entity DVR
      • [Deprecated] Disable Live Entity DVR
      • Reset Ingest Key
    • Live Sessions
      • Retrieve A Live Session
      • List All Live Sessions
    • Video Entities
      • Retrieve A Video Entity
      • Update A Video Entity
      • Publish A Video Entity
      • Delete A Video Entity
      • List All Video Entities
    • Video Presets
      • Create a Video Preset
      • Retrieve a Video Preset
      • Update a Video Preset
      • Delete a Video Preset
      • List all Video Presets
      • Add Profile(s) to Video Preset
      • Remove Profile(s) from Video Preset
    • Video Profiles
      • List All Video Profiles
    • Events
      • Retrieve An Event
      • List All Events
      • Event Types
    • Webhook Endpoints
      • Create Webhook Endpoint
      • Retrieve Webhook Endpoint
      • Update Webhook Endpoint
      • [Deprecated] Update Webhook Endpoint
      • Delete Webhook Endpoint
      • List All Webhook Endpoints
      • [Deprecated] Enable A Webhook Endpoint
      • [Deprecated] Disable A Webhook Endpoint
  • SDK REFERENCE
    • Introduction
    • Android SDK
      • Android Player SDK
      • Android Broadcast SDK
    • iOS SDK
      • iOS Player SDK
      • iOS Broadcast SDK
    • Web Player SDK
  • API UPGRADES
    • Release Notes
    • API Changelog
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Live Entities

[Deprecated] Update A Live Entity

Updates a specified live entity's name and/or description. Any parameters not provided will be left unchanged.

/v1/live_entities/:id

PUT

Path Parameters

Name
Type
Description

id

string

The identifier of the live entity to be updated.

Request Body

Name
Type
Description

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.

{
  "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"
  },
  "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"
}
{
 "message": "You are unauthorized to access the requested resource. Please verify and resubmit.",
 "error_type": "invalid_request_error"
}
{
 "message": "The live entity you requested does not exist.",
 "error_type": "invalid_request_error"
}
{
 "message": "An unexpected error occurred on Uiza's end.",
 "error_type": "api_error"
}
Sample Request
curl -X PUT 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"}'
PreviousUpdate A Live EntityNextDelete A Live Entity

Last updated 5 years ago

Was this helpful?