DELETE Restream

Overview

---

The table below provides key details about the DELETE method for removing a specific restream.

DELETE Restream
Method	DELETE
URL or Endpoint	/api/v1/projectId/restreams/restreamId
Headers	Authorization
Parameters	restreamId, projectId
Body	Not applicable

The description of the URL parameter is as follows:

restreamId URL Parameter
URL Parameter Name	restreamId
Mandatory	Yes
Type	string
Description	Unique Id of the restream.

tip

To retrieve the unique ID needed to delete the desired restream, use the "GET Restreams" Method.

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

This method does not require the request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": true,
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	boolean	If the response is successful it will return true. Otherwise, it will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from the back-end.
result	boolean	Indicates the result of the request.(True for success, false for failure).
resultInfo	string	Returns extra information about the result.
statusCode	integer	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed