Uiza Documentation
2022-06-22
2022-06-22
  • Hola! 👋
  • Getting Started
    • Introduction
    • Authentication
    • Errors
    • Quick Starts
      • Live Streaming
      • Video Streaming
    • Pagination
    • Recommended Specifications
    • 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
      • Delete a live entity
      • List all live entities
      • Create a live relay
      • Update a live relay
      • Delete a live relay
    • Video Entities
      • Create a video entity
      • Retrieve a video entity
      • Update a video entity
      • Delete a video entity
      • List all video entities
    • Events
      • Event Types
    • Webhook Endpoints
      • Verifying signatures
      • Create a webhook endpoint
      • Update a webhook endpoint
      • Get a webhook endpoint
      • List all webhook endpoint
  • SDK REFERENCE
    • Introduction
    • Android SDK
      • Android Player SDK
      • Android Broadcast SDK
    • iOS SDK
      • iOS Player SDK
      • iOS Broadcast SDK
    • Web Player SDK
    • Flutter SDK
  • API UPGRADES
    • Release Notes
    • API Changelog
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Live Entities

Delete a live entity

Permanently deletes a live entity. You need to stop broadcasting from your end to be able to delete a live entity. Once a live entity is deleted, it cannot be undone.

/v1/live-entities/:id

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

Path Parameters

Name
Type
Description

id

string

The identifier if the live event to be deleted

{}
{
  "message": "The live entity is fail on allocating resource and will be deleted by system.",
  "error_type": "invalid_request_error"
}
{
  "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": "The live entity is broadcasting and could not be deleted. Please, stop the live session and try again.",
  "error_type": "video_error"
}
{
  "message": "An unexpected error occurred on Uiza's end.",
  "error_type": "api_error"
}
Sample Request
curl -X DELETE 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'
PreviousUpdate a live entityNextList all live entities

Last updated 2 years ago

Was this helpful?