Skip to content

Update capture source

PATCH
/api/v1/capturesources/{id}

Roles required: Admin

Partially update a capture source by specifying the properties to update.

Parameters

Path Parameters

id*

Capture Source ID

Typeinteger
Required
Example1234567890

Request Body

JSON
{
"camera_hardware": "pi cam v2 (wide angle lens)",
"location": "-32.12345,139.12345",
"name": "Stony Point Cuttle Cam",
"site_id": 246813579
}

Responses

OK

Samples

cURL
curl -X PATCH https://openfish.appspot.com/api/v1/capturesources/{id}
JavaScript
fetch("https://openfish.appspot.com/api/v1/capturesources/{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/capturesources/{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/capturesources/{id}")
print(response.json())