Delete a destination
DELETE/v1/streams/destinations/{destinationId}
DELETE
/v1/streams/destinations/{destinationId}
const url = 'https://api.ligr.live/rest/v1/streams/destinations/1';const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url https://api.ligr.live/rest/v1/streams/destinations/1 \ --header 'Authorization: Bearer <token>'Deletes a destination. A destination linked to a running stream is refused with 409
IN_USE_BY_STREAM. Stop the stream, or remove the destination from it, first.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”destinationId
required
Entity identifier
integer format: int32
The destination identifier
Responses
Section titled “Responses”Ok
Media typeapplication/json
object
success
required
boolean
Examplegenerated
{ "success": true}Request is invalid
Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{ "message": "example", "details": { "additionalProperty": "example" }}Missing or invalid api key
Media typeapplication/json
object
message
required
string
Examplegenerated
{ "message": "example"}Api key provides insufficient access for the request
Media typeapplication/json
object
message
required
string
Examplegenerated
{ "message": "example"}Destination not found
Media typeapplication/json
object
message
required
string
Examplegenerated
{ "message": "example"}A running stream uses the destination
Media typeapplication/json
Body of a 409 answer for an input or destination that a running stream uses.
code is always IN_USE_BY_STREAM. details names one stream per line, by its
streamSettingsId.
object
message
required
string
code
required
string
details
required
Array<string>
Examplegenerated
{ "message": "example", "code": "example", "details": [ "example" ]}Organization has made too many requests
Media typeapplication/json
object
message
required
string
Examplegenerated
{ "message": "example"}An unexpected error has occured. If problems persist please contact support
Media typeapplication/json
object
message
required
string
Examplegenerated
{ "message": "example"}