POST Restream

Overview

---

The table below provides key details about the POST method for creating a new restream.

POST Restream
Method	POST
URL or Endpoint	/api/v1/projectId/restreams
Headers	Authorization
Parameters	projectId
Body	videoId, title, streamUrl, streamKey, status

The description of the URL parameter is as follows:

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

Request Body

{
  "videoId": "string",
  "title": "string",
  "streamUrl": "string",
  "streamKey": "string",
  "status": true
}

The description of the body parameters is as follows:

Parameter Name	Mandatory	Type	Description
videoId	Yes	string	Public identifier of the live video
title	Yes	string	Title of the restream
streamUrl	Yes	string	URL of the live video stream
streamKey	Yes	string	Key required to access the live video stream
status	Yes	boolean	Status of the live video

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "{id}",
    "title": "{title}",
    "streamKey": "{streamKey}",
    "streamUrl": "{streamUrl}",
    "status": true,
    "videoId": "{videoId}"
  },
  "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
title	string	Title of the restream.
streamKey	string	Key required to access the live video stream.
streamUrl	string	URL of the live video stream.
status	boolean	Status of the live video (true for active, false for inactive).
videoId	string	Public identifier of the live video.
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