Skip to main content

PUT Restream

Overview


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

PUT Restream
MethodPUT
URL or Endpoint/api/v1/projectId/restreams/restreamId/toggle
HeadersAuthorization
ParametersrestreamId, projectId
BodyNot applicable

The description of the URL parameter is as follows:

restreamId URL Parameter
URL Parameter NamerestreamId
MandatoryYes
Typestring
DescriptionUnique 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 NameprojectId
MandatoryYes
Typestring
DescriptionUnique 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 NameTypeDescription
successbooleanIf the response is successful it will return true. Otherwise, it will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from the back-end.
idintegerIdentifier of the restream.
statusbooleanStatus of the restream.
resultInfostringReturns extra information about the result.
statusCodeintegerReturns 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