PUT Restream

Overview

---

The table below provides key details about the PUT method for updating status of a specific restream.

PUT Restream
Method	PUT
URL or Endpoint	/api/v1/projectId/restreams/restreamId/toggle
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 required to modify the desired restream, use the "GET Restreams" Method.

This version clarifies the action and provides a clear link to the relevant documentation.

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": {
    "id": "{id}",
    "status": false
  },
  "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.
id	integer	Identifier of the restream.
status	boolean	Status of the restream.
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