8
REST API
The REST API need to have Autorization: Bearer <REST API access token> in the HTTP header. The response will
be JSON
formatted with a “message” field containing a JSON string explaining the cause of the error if any. Note that
we are using self-signed certificate.
Here is the complete list of commands supported through the REST API
Command URL
Body arguments
Return code
Return body
GET
https://<IP>/api/v1/status
200 => success
401 => authorization error
JSON object
with multiple
fields
POST
https://<IP>/api/v1/setHdmi
mode=< hdmiModeIndex >
0 => 1080P60
1 => 1080P50
2 => 720P60
3 => 720P50
4 => 4K24
5 => 4K25
6 => 4K30
200 => success
400 => error
401 => authorization error
JSON object
with message
field
explaining
error if any
POST
https://<IP>/api/v1/setVideoFormat
format=<formatIndex>
0 => 1st preferred format
1 => 2nd preferred format
2 => 3rd preferred format
3 => 4th preferred format
200 => success
400 => error
401 => authorization error
JSON object
with message
field
explaining
error if any
POST
https://<IP>/api/v1/
disableSerialInterface
<Integer>
If integer is 0, will disable
serial interface, otherwise
will enable it.
200 => success
400 => error
401 => authorization error
JSON object
with message
field
explaining
error if any
GET
https://<IP>/api/v1/serialRead
200 => success
400 => error
401 => authorization error
JSON object
with message
field
containing
characters
read from
serial port
POST
https://<IP>/api/v1/serialWrite
<Content to write >
200 => success
400 => error
401 => authorization error
JSON object
with message
field
explaining
error if any
POST
https://<IP>/api/v1/pan
<Integer>
The sign specifies the
direction.
We multiply the argument by
the camera smallest step,
and if the speed is too fast,
we go as fast as the camera
allow. We recommend using
values between -10 and 10.
200 => success
400 => error
401 => authorization error
JSON object
with message
field
explaining
error if any
POST
https://<IP>/api/v1/tilt
<Integer>
The sign specifies the
direction.
We multiply the argument by
the camera smallest step,
and if the speed is too fast,
200 => success
400 => error
401 => authorization error
JSON object
with message
field
explaining
error if any