Skip to content

Update video stream

PATCH
/api/v1/videostreams/{id}

Roles required: Curator or Admin

Partially update a video stream by specifying the properties to update.

Parameters

Path Parameters

id*

Video Stream ID

Typeinteger
Required
Example1234567890

Request Body

JSON
{
"annotator_list": [
"user@example.com"
],
"capturesource": 1234567890,
"endTime": "2023-05-25T16:30:00Z",
"startTime": "2023-05-25T08:00:00Z",
"stream_url": "https://www.youtube.com/watch?v=abcdefghijk"
}

Responses

OK

Samples

cURL
curl -X PATCH https://openfish.appspot.com/api/v1/videostreams/{id}
JavaScript
fetch("https://openfish.appspot.com/api/v1/videostreams/{id}", { method: "PATCH" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://openfish.appspot.com/api/v1/videostreams/{id}");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Python
import requests
response = requests.patch("https://openfish.appspot.com/api/v1/videostreams/{id}")
print(response.json())