API Calls

Table of Contents

Document Purpose

The purpose of this document is to provide usage, general understanding and examples of API calls commonly used with the Rayfin Micro camera.

API Calls Index

Aux Input Commands UPDATED
Last updated: 2024/4/30 9:16:54
Path To	Name	Description/Function
/api/auxinput	/device/{input}	Get the aux port assigned.
/api/auxinput	/{input}	Get the aux port assigned.
/api/auxinput	/{auxInput}/{auxDevice}	Set the aux input.
/api/auxinput	/{auxInput}/{auxDevice}/{baudRate}/{serialStandard}	Set the aux input.
Exposure Commands UPDATED
Last updated: 2024/4/30 9:16:54
Path To	Name	Description/Function
/api/exposure	/auto	Auto exposure.
/api/exposure	/manual	Manual exposure.
/api/exposure	/ev/down	Decrement exposure value.
/api/exposure	/ev/up	Increment exposure value.
/api/exposure	/ev	Get the exposure value.
/api/exposure	/framerate	Gets the shutter speed in nanoseconds.
/api/exposure	/isauto	Is exposure auto.
/api/exposure	/iso	Get the ISO value.
/api/exposure	/shutter	Gets the shutter speed in nanoseconds.
/api/exposure	/shutter/limit	Gets the shutter limit in nanoseconds.
/api/exposure	/strobecompensation	Get the number of exposure stops for strobe compensation.
/api/exposure	/iso/down	ISO down.
/api/exposure	/iso/up	ISO up.
/api/exposure	/shutter/islocked	Gets a value indicating whether the shutter is locked.
/api/exposure	/framerate/lock/{value}	Lock the framerate to the given value specified in frames/second.
/api/exposure	/shutter/lock	Lock the shutter to the current value.
/api/exposure	/shutter/lock/{value}	Lock the shutter to the given value specified in nanoseconds.
/api/exposure	/shutter/limit/reset	Resets the shutter limit to 0.
/api/exposure	/ev/{value}	Set the exposure value.
/api/exposure	/iso/{value}	ISO to.
/api/exposure	/shutter/limit/set	Send the shutter limit to the camera.
/api/exposure	/shutter/limit/set/{limit}	Send the shutter limit to the camera.
/api/exposure	/shutter/down	Shutter down.
/api/exposure	/shutter/limit/down	Shutter limit down.
/api/exposure	/shutter/limit/up	Shutter limit up.
/api/exposure	/shutter/up	Shutter up.
/api/exposure	/strobecompensation/down	Decrease the number of exposure stops for strobe compensation.
/api/exposure	/strobecompensation/up	Increase the number of exposure stops for strobe compensation.
/api/exposure	/framerate/unlock	Unlock the framerate.
/api/exposure	/shutter/unlock	Unlock the shutter.
/api/exposure	/shutter/{value}	Shutter to.
Time Commands
Last updated: 2023/6/13 16:9:11
Path To	Name	Description/Function
/api/time	/ntp/enable	Enable auto time.
/api/time	/ntp/disable	Enable manual time.
/api/time	/ntp/drift	Gets the current NTP drift in ms.
/api/time	/ntp/driftthreshold	Gets the NTP drift threshold in ms.
/api/time	/ntp/server	Get the current NTP server address.
/api/time	/datetime	Get the current date and time on the camera.
/api/time	/timezone	Set the current time zone on the camera.
/api/time	/ntp/isenabled	Query for clock mode is auto.
/api/time	/ntp/sync	Synchronizes the camera with the configured NTP server.
/api/time	/ntp/driftthreshold/{value}	Sets the NTP drift threshold in ms.
/api/time	/ntp/server/{server}	Set the NTP server address.
/api/time	/datetime/{millis}	Set the current date and time on the camera.
/api/time	/timezone	Set the current time zone on the camera.
Stills Commands
Last updated: 2024/2/27 9:34
Path To	Name	Description/Function
/api/still	/jpegquality	Get the JPEG quality.
/api/still	/pathtemplate	Get the path template.
/api/still	/hascapturefailed	Gets a value indicating whether the still capture has failed.
/api/still	/isstillrequestpending	Gets a value indicating whether a still request is pending.
/api/still	/reset	Reset the image reader in the event of a failure.
/api/still	/jpegquality/{value}	Set the JPEG quality.
/api/still	/pathtemplate	Set the path template.
/api/still	/take	Take a still with the camera.
/api/still	/takeanddispose	Take a still with the camera.
/api/still	/takeandftp	Take a still with the camera and upload it to ftp.
/api/still	/takeandget	Take a still with the camera.
/api/still	/takeandsave	Take a still with the camera with the given path template. (Method=POST
/api/still	/takeandsave	Take a still with the camera with the given path template. (Method=GET)
Aquorea MK3/Led Commands
This endpoint `/api/aquoreamk3` has been deprecated. Please use the

new endpoint `/api/led/*`.
Last updated: 2024/2/27 11:04
Path To	Name	Description/Function
/api/aquoreamk3	/strobe/disable	Disable the strobe.
/api/aquoreamk3	/strobe/enable	Enable the strobe.
/api/aquoreamk3	/lamp/brightness	Get the lamp brightness.
/api/aquoreamk3	/strobe/brightness	Get the strobe brightness.
/api/aquoreamk3	/isattached	Gets a value indicating whether the camera has leds.
/api/aquoreamk3	/lamp/ison	Gets a value indicating whether the camera lamp is on.
/api/aquoreamk3	/strobe/isenabled	Gets a value indicating whether the camera strobe is enabled.
/api/aquoreamk3	/lamp/off	Turn the lamp off.
/api/aquoreamk3	/lamp/on	Turns on the attached LED and sets the brightness to 100.
/api/aquoreamk3	/lamp/brightness/up	Increment lamp brightness by 5.
/api/aquoreamk3	/lamp/brightness/down	Decrement lamp brightness by 5.
/api/aquoreamk3	/strobe/brightness/up	Increment strobe brightness by 5.
/api/aquoreamk3	/strobe/brightness/down	Decrement strobe brightness by 5.
/api/aquoreamk3	/lamp/brightness/{value}	Set the lamp brightness.
/api/aquoreamk3	/strobe/brightness/{value}	Set the strobe brightness.

Device Commands
Last updated: 2024/2/26 18:9:47
Path To	Name	Description/Function
/api/device	/ambient	Gets the Ambient temperature of the device.
/api/device	/cpu	Gets the CPU temperature of the device.
/api/device	/firmwareversion	Gets the ROM version number.
/api/device	/humidity	Gets the Humidity of the device.
/api/device	/nickname	Gets the Nickname of the device.
/api/device	/nickname/{nickname}	Gets the Nickname of the device.
/api/device	/ping	A simple way to ping the application.
/api/device	/restart	Reboot the camera.
/api/device	/romversion	Gets the ROM version number.
/api/device	/serialnumber	Gets the camera serial number.
/api/device	/model	Gets the camera model.
/api/device	/generation	Gets the camera model.
/api/device	/storage	Remaining storage.
Legacy
Last updated: 2024/2/26 18:9:47
Path To	Name	Description/Function
/api/device	/reboot	Restart the Rayfin device.
Application Commands
Last updated: 2023/8/31 9:4:53
Path To	Name	Description/Function
/api/app	/ping	A simple way to ping the application.
/api/app	Command has been moved to the “Device Commands” section.
/api/app	/reboot	Restart the camera.
/api/app	Command has been moved to the “Device Commands” section.
/api/app	/restart	Restart the software on the Rayfin device.
/api/app	/version	Gets the app version number.
/api/app	/romversion	Gets the ROM version number.
/api/app	Command has been moved to the “Device Commands” section.
/api/app	/firmwareversion	Gets the ROM version number.
/api/app	Command has been moved to the “Device Commands” section.
/api/app	/serialnumber	Gets the camera serial number.
/api/app	Command has been moved to the “Device Commands” section.
Lens Commands
Last updated: 2024/2/26 18:40:53
Path To	Name	Description/Function
/api/lens	/focus/limit/{farLimit}/{nearLimit}	Set focus limit in AF.
/api/lens	/focus/auto	Enable auto focus on the lens.
/api/lens	/focus/manual	Enable manual focus on the lens.
/api/lens	/focus/far	Focus the lens far.
/api/lens	/focus/near	Focus the lens near.
/api/lens	/focus/limit	Gets the AF limits set in the sysProp.
/api/lens	/focus	Get the current focus value.
/api/lens	/type	Get the lens type.
/api/lens	/zoom	Get the zoom level.
/api/lens	/focus/isauto	Gets a value indicating whether the lens is in auto focus.
/api/lens	/ois/isenabled	Get a value indicating whether OIS is enabled.
/api/lens	/ois/disable	Disable OIS.
/api/lens	/ois/enable	Enable OIS.
/api/lens	/pan/left	Activates a pan left action.
/api/lens	/pan/left/{speed}	Activates a pan left with a specific speed.
/api/lens	/pan/right	Activates a pan right action.
/api/lens	/pan/right/{speed}	Activates a pan right action and specifies the speed.
/api/lens	/focus/{value}	Set the focus value.
/api/lens	/ptz/stop	Stops all continuous PTZ actions.
/api/lens	/tilt/down/{speed}	Activates a tilt down action and specifies the speed.
/api/lens	/tilt/down/	Activates a tilt down action and specifies the speed.
/api/lens	/tilt/up/{speed}	Activates a tilt up action and specifies the speed.
/api/lens	/tilt/up	Activates a tilt up action and specifies the speed.
/api/lens	/zoom/in	Zoom the lens in.
/api/lens	/zoom/out	Zoom the lens out.
/api/lens	/zoom/{value}	Set the zoom level.
File Server Commands
Last updated: 2023/6/23 15:32:49
Path To	Name	Description/Function
/api/files	/download/{fileName}	Downloads the specified file.
/api/files	/download/{dir1}/{fileName}	Download the specified file.
/api/files	/getfileinfo	Get the specified file info.
/api/files	/download/{dir1}/{dir2}/{fileName}	Download the specified file.
/api/files	/download/{dir1}/{dir2}/{dir3}/{fileName}	Download the specified file.
/api/files	/download/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}	Download the specified file.
/api/files	/download/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}	Download the specified file.
/api/files	/downloadfolder/{folderName}	Downloads the specified file.
/api/files	/downloadthumbnail/{dir1}/{fileName}	Download the specified thumbnail.
/api/files	/downloadthumbnail/{dir1}/{dir2}/{fileName}	Download the specified thumbnail.
/api/files	/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}	Download the specified thumbnail.
/api/files	/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}	Download the specified thumbnail.
/api/files	/downloadthumbnail/{fileName}	Downloads the specified thumbnail.
/api/files	/list	List files in the root directory.
/api/files	/list/{dir1}	List files in the specified directory of depth 1.
/api/files	/list/{dir1}/{dir2}	List files in the specified directory of depth 2.
/api/files	/list/{dir1}/{dir2}/{dir3}	List files in the directory of depth 3.
/api/files	/list/{dir1}/{dir2}/{dir3}/{dir4}	List files in the directory of depth 4.
/api/files	/list/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}	List files in the directory of depth 5.
/api/files	/wlist	List files in the root directory.
/api/files	/wlist/{dir1}	List files in the directory depth 1.
/api/files	/wlist/{dir1}/{dir2}	List files in the directory depth 2.
/api/files	/wlist/{dir1}/{dir2}/{dir3}	List files in the directory depth 3.
/api/files	/wlist/{dir1}/{dir2}/{dir3}/{dir4}	List files in the directory depth 4.
/api/files	/wlist/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}	List files in the directory depth 5.
White Balance Commands
Last updated: 2023/7/28 10:27:55
Path To	Name	Description/Function
/api/whitebalance	/bluechannel/down	Blue channel Decrement.
/api/whitebalance	/bluechannel/up	Blue channel increment.
/api/whitebalance	/bluechannel	Get blue channel value.
/api/whitebalance	/greenchannel	Get green channel value.
/api/whitebalance	/redchannel	Get red channel value.
/api/whitebalance	/mode	White balance mode 0=manual or 1=auto.
/api/whitebalance	/greenchannel/down	Green channel Decrement.
/api/whitebalance	/greenchannel/up	Green channel increment.
/api/whitebalance	/redchannel/down	Red channel Deccrement.
/api/whitebalance	/redchannel/up	Red channel increment.
/api/whitebalance	/bluechannel/{value}	Update the blue channel.
/api/whitebalance	/greenchannel/{value}	Update the green channel.
/api/whitebalance	/redchannel/{value}	Update the red channel.
/api/whitebalance	/mode/{mode}	Updates the white balance mode.
RTSP Commands
Last updated: 2023/6/13 16:32:15
Path To	Name	Description/Function
/api/rtsp	/get	Get the current configuration.
/api/rtsp	/update	Update the streaming settings.
SkateMK2/Laser Commands
This endpoint `/api/skatemk2` has been deprecated. Please use the new endpoint `/api/laser/*`.
Last updated: 2024/2/27 1:48:46
Path To	Name	Description/Function
/api/laser	/ison	Gets a value indicating whether the cameras lasers are on.
/api/laser	/isinverted	Gets a value indicating whether the cameras lasers are inverted.
/api/laser	/invert/{val}	Invert laser controls.
/api/laser	/isattached	Gets a value indicating whether the camera has lasers.
/api/laser	/off	Turn the lasers off.
/api/laser	/on	Turn the lasers on.
State Commands
Last updated: 2023/7/5 15:8:32
Path To	Name	Description/Function
/api/state		Get the state of the camera.
Network Commands
Last updated: 2024/2/27 10:31:40
Path To	Name	Description/Function
/api/network	/connectionspeed	Get the network link speed.
/api/network	/enabledhcp	Enable DHCP on the camera.
/api/network	/staticfallbackseconds/{seconds}	Sets the number of seconds to delay before falling back to static IP.
/api/network	/enablestaticip	Enable static IP.
/api/network	/enablestaticip/{ip}/{gateway}/{dns1}/{dns2}/{subnetmask}	Enable static IP.
/api/network	/get	Get the network state.
Pan/Tilt Commands
Last updated: 2023/8/30 15:58:25
Path To	Name	Description/Function
/api/pantilt	/pan/left	Activates a pan left action.
/api/pantilt	/pan/right	Activates a pan right action.
/api/pantilt	/pan/to/{degrees}	Activates a pan right action.
/api/pantilt	/stop	Stops all continuous PTZ actions.
/api/pantilt	/tilt/down/	Activates a tilt down action and specifies the speed.
/api/pantilt	/tilt/up	Activates a tilt up action and specifies the speed.
/api/pantilt	/tilt/to/{degrees}	Activates a tilt right action.
/api/pantilt	/state	Activates a tilt up action and specifies the speed.

Aux Input Details

/device/{input}

Function	Get the aux port assigned.
Method	Get
Response	Aux input device.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/auxinput/device/{input}`

/{input}

Function	Get the aux port assigned.
Method	Get
Response	Aux input device.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/auxinput/{input}`

/{auxInput}/{auxDevice}

Function	Set the aux input.
Method	Get
Response	Aux device.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/auxinput/{auxInput}/{auxDevice}`

/{auxInput}/{auxDevice}/{baudRate}/{serialStandard}

Function	Set the aux input.
Method	Get
Response	Serial standard of the aux device.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/auxinput/{auxInput}/{auxDevice}/{baudRate}/{serialStandard}`

Exposure Details

/auto

Function	Auto exposure.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/auto`

/manual

Function	Manual exposure.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/manual`

/ev/down

Function	Decrement exposure value.
Method	Get
Response	New exposure value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/ev/down`

/ev/up

Function	Increment exposure value.
Method	Get
Response	New exposure value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/ev/up`

/ev

Function	Get the exposure value.
Method	Get
Response	The exposure value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/ev`

/isauto

Function	Is exposure auto.
Method	Get
Response	True if the exposure is in auto, false if in manual.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/isauto`

/iso

Function	Get the ISO value.
Method	Get
Response	The ISO value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/iso`

/shutter

Function	Gets the shutter speed in nanoseconds.
Method	Get
Response	The current shutter speed in nanoseconds.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/shutter`

/iso/down

Function	ISO down.
Method	Get
Response	The ISO.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/iso/down`

/iso/up

Function	ISO up.
Method	Get
Response	The ISO.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/iso/up`

/shutter/islocked

Function	Gets a value indicating whether the shutter is locked.
Method	Get
Response	True if the shutter is locked. False if not.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/shutter/islocked`

/shutter/lock

Function	Lock the shutter to the current value.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/shutter/lock`

/shutter/lock/{value}

Function	Lock the shutter to the given value specified in nanoseconds.
Method	Get
Response	Value to lock the shutter to specified in nanoseconds.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/shutter/lock/{value}`

/framerate/lock/{value}

Function	Lock the framerate to the given value specified in frames/second.
Method	Get
Response	Value to lock the shutter to specified in frames/second.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/framerate/lock/{value}`

/ev/{value}

Function	Set the exposure value.
Method	Get
Response	New exposure value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/ev/{value}`

/iso/{value}

Function	ISO to.
Method	Get
Response	New ISO value. The ISO range is between 50 and 3200.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/iso/{value}`

/shutter/limit/set/{limit}

Function	Send the shutter limit to the camera.
Method	Get
Response	Shutter limit.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/shutter/limit/set/{limit}`

/shutter/down

Function	Shutter down.
Method	Get
Response	The shutter speed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/shutter/down`

/shutter/up

Function	Shutter up.
Method	Get
Response	The shutter speed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/shutter/up`

/shutter/unlock

Function	Unlock the shutter.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/shutter/unlock`

/framerate/unlock

Function	Unlock the framerate.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/framerate/unlock`

/shutter/{value}

Function	Shutter to.
Method	Get
Response	New shutter value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/exposure/shutter/{value}`

Time Details

/ntp/enable

Function	Enable auto time.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/ntp/enable`

/ntp/disable

Function	Enable manual time.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/ntp/disable`

/ntp/drift

Function	Gets the current NTP drift in ms.
Method	Get
Response	The ntp server address.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/ntp/drift`

/ntp/driftthreshold

Function	Gets the NTP drift threshold in ms.
Method	Get
Response	The ntp server address.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/ntp/driftthreshold`

/ntp/server

Function	Get the current NTP server address.
Method	Get
Response	The ntp server address.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/ntp/server`

/datetime

Function	Get the current date and time on the camera.
Method	Get
Response	The current date and time on the camera in milliseconds since the unix epoch.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/datetime`

/timezone

Function	Set the current time zone on the camera.
Method	Get
Response	The time zone.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/timezone`

/ntp/isenabled

Function	Query for clock mode is auto.
Method	Get
Response	True if the camera is in auto time mode.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/ntp/isenabled`

/ntp/sync

Function	Synchronizes the camera with the configured NTP server.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/ntp/sync`

/ntp/driftthreshold/{value}

Function	Sets the NTP drift threshold in ms.
Method	Get
Response	A drift threshold in ms.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/ntp/driftthreshold/{value}`

/ntp/server/{server}

Function	Set the NTP server address.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/ntp/server/{server}`

Source: https://gist.github.com/mutin-sa/eea1c396b1e610a2da1e5550d94b0453
Server Name	Server URL
Google Public NTP	time.google.com
Google Public NTP	time1.google.com
Cloudflare NTP	time.cloudflare.com

/datetime/{millis}

Function	Set the current date and time on the camera.
Method	Get
Response	A datetime to set.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/time/datetime/{millis}`

/timezone

Function	Set the current timezone on the camera using specified timezones. Note this is a asynchronous operation.
Method	POST
Body	CODE `{ "TimeZone":"{Time Zone ID}" }`
Response	Status code 200, for an completed operation being preformed.
Explanation	See the table below for a list of all possible timezone values.
Starting Value	N/A
Example	Example 1 CODE `{ "TimeZone":"America/St_Johns" }` Output CODE `$ curl -X POST http://<ip>:<port>/api/time/timezone -H 'Content-Type: application/json' -d '{ "TimeZone":"America/St_Johns" }'`

Time Zone ID	Time Zone ID	Time Zone ID
Source: https://docs.poly.com/en-US/bundle/trio-ag-5-9-3-AA/page/r2732735.html
Pacific/Midway	Atlantic/South_Georgia	Asia/Yerevan
Pacific/Honolulu	Atlantic/Azores	Asia/Dubai
America/Anchorage	Atlantic/Cape_Verde	Asia/Kabul
Mexico/BajaNorte	Africa/Casablanca	Asia/Karachi
America/Phoenix	Europe/London	Asia/Tashkent
America/Chihuahua	Europe/Amsterdam	Asia/Yekaterinburg
America/Denver	Europe/Belgrade	Asia/Calcutta
America/Costa_Rica	Europe/Brussels	Asia/Colombo
America/Chicago	Europe/Sarajevo	Asia/Katmandu
America/Mexico_City	Africa/Brazzaville	Asia/Dhaka
America/Regina	Africa/Windhoek	Asia/Rangoon
America/Bogota	Asia/Amman	Asia/Krasnoyarsk
America/New_York	Europe/Athens	Asia/Bangkok
America/Caracas	Asia/Beirut	Asia/Jakarta
America/Barbados	Africa/Cairo	Asia/Shanghai
America/Halifax	Europe/Helsinki	Asia/Hong_Kong
America/Manaus	Asia/Jerusalem	Asia/Irkutsk
America/Santiago	Africa/Harare	Asia/Kuala_Lumpur
America/St_Johns	Europe/Moscow	Asia/Taipei
America/Sao_Paulo	Asia/Kuwait	Asia/Tokyo
America/Argentina/Buenos_Aires	Africa/Nairobi	Asia/Yakutsk
America/Godthab	Asia/Tehran	Australia/Adelaide
America/Montevideo	Asia/Baku

Stills Details

/hascapturefailed

Function	Gets a value indicating whether the still capture has failed.
Method	Get
Response	True if the previous still still capture has failed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/hascapturefailed`

/reset

Function	Reset the image reader in the event of a failure.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/reset`

/jpegquality

Function	Get the JPEG quality.
Method	Get
Response	The quality of the JPEG.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/jpegquality`

/pathtemplate

Function	Get the path template.
Method	Get
Response	The template of the still path.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/pathtemplate`

/isstillrequestpending

Function	Gets a value indicating whether a still request is pending.
Method	Get
Response	True if a still request is still pending.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/isstillrequestpending`

/jpegquality/{value}

Function	Set the JPEG quality.
Method	Get
Response	Value of the quality to set.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/jpegquality/{value}`

/pathtemplate

Function	Set the path template. Note this is a asynchronous operation.
Method	Post
Body	CODE `{ "PathTemplate":"ProjectName-Still/{yyyy}{MM}{dd}-{HH}{mm}{ss}" }`
Response	A representing the asynchronous operation.
Explanation	The filename formatting, see the available formats below: yyyy = Four(4) digit current year. MM = Two(2) digit month. dd = Two(2) digit day. HH = Two(2) digit 24-hour clock. hh = Two(2) digit 12-hour clock. Will include “AM” and “PM” in the results. mm = Minutes with a leading zero. ss = Seconds with leading zero. fff = Represents the three most significant digits of the seconds' fraction; that is, it represents the milliseconds in a date and time value.
Example	Example 1 CODE `{ "PathTemplate":"ProjectName-Still/{yyyy}{MM}{dd}-{HH}{mm}{ss}" }` Output CODE `$ curl -X POST http://<ip>:<port>/api/still/pathtemplate/get -H 'Content-Type: application/json' -d '{ "PathTemplate":"ProjectName-Still/{yyyy}{MM}{dd}-{HH}{mm}{ss}" }' $ "ProjectName-Still/2023-05-17-160223"`

/take

Function	Take a still with the camera.
Method	Get
Response	The byte array of the still.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/take`

/takeanddispose

Function	Take a still with the camera.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/takeanddispose`

/takeandget

Function	Take a still with the camera.
Method	Get
Response	The byte array of the still.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/takeandget`

/takeandsave

Function	Take a still with the camera with the given path template.
Method	Post
Body	CODE `{ "Template": "{string}" }`
Response	Path of the still taken.
Explanation	Using the command: CODE `http://<ip>:8080/api/still/takeandsave` With the template provided above, will give the result provided below.
Example	Example 1 CODE `{ "Template": "ProjectName-Still/{yyyy}{MM}{dd}-{HH}{mm}{ss}" }` CODE `$ curl -X POST http://<ip>:8080/api/still/takeandsave -H 'Content-Type: application/json' -d '{ "Template": "ProjectName-Still/{yyyy}{MM}{dd}-{HH}{mm}{ss}" }'` Results CODE `"/mnt/expand/64180671-0e95-4e34-9381-0780ce582c9c/DCIM/ProjectName-Still/20230803-093136.jpg"`

/takeandsave

Function	Take a still with the camera with the given path template.
Method	Get
Response	Path of the still taken.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/takeandsave`

Aquorea MK3 LED Details

/strobe/disable

Function	Disable the strobe.
Method	GET
Response	Status code 200, for an completed operation being preformed.
Explanation	Stops the LED from flashing.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/strobe/disable`

/strobe/enable

Function	Enable the strobe.
Method	GET
Response	Status code 200, for an completed operation being preformed.
Explanation	The LED will start flashing.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/strobe/enable`

/isattached

Function	Gets a value indicating whether the camera has LED's.
Method	GET
Response	True if the Rayfin has LED's.
Explanation	Validation to find out if the LED is attached.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/isattached`

/lamp/ison

Function	Gets a value indicating whether the camera lamp is on.
Method	GET
Response	True if the LED is turned on.
Explanation	Validation to find out if the LED is turned on.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/lamp/ison`

/strobe/isenabled

Function	Gets a value indicating whether the camera strobe is enabled.
Method	GET
Response	True if the Rayfin strobe is enabled.
Explanation	Validation to find out if the LED strobe is enabled.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/strobe/isenabled`

/lamp/off

Function	Turn the lamp off.
Method	GET
Response	Status code 200, for an completed operation being preformed.
Explanation	Turns off the LED attached.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/lamp/off`

/lamp/on

Function	Turn the lamp on.
Method	GET
Response	Status code 200, for an completed operation being preformed.
Explanation	Turns on the LED attached and sets the brightness to 100%.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/lamp/on`

/lamp/brightness

Function	Get the lamp brightness.
Method	GET
Response	The lamp brightness.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/lamp/brightness`

/lamp/brightness/{value}

Function	Set the lamp brightness.
Method	GET
Response	Brightness value from 0-100.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/lamp/brightness`

/strobe/brightness

Function	Get the strobe brightness.
Method	GET
Response	The lamp brightness.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/lamp/brightness`

/strobe/brightness/{value}

Function	Set the strobe brightness. Note this is a asynchronous operation.
Method	GET
Response	Brightness value from 0-100.
Starting Value	N/A
Example	CODE `$ curl http://<ip>:<port>/api/led/lamp/brightness`

Device Details

/reboot

Function	Restart the Rayfin device (legacy command)
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/reboot`

/ambient

Function	Gets the Ambient temperature of the device.
Method	Get
Response	Ambient temperature.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/ambient`

/cpu

Function	Gets the CPU temperature of the device.
Method	Get
Response	CPU temperature.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/cpu`

/firmwareversion

Function	Gets the ROM version number.
Method	Get
Response	The ROM version.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/firmwareversion`

/humidity

Function	Gets the Humidity of the device.
Method	Get
Response	Humidity.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/humidity`

/nickname

Function	Gets the Nickname of the device.
Method	Get
Response	Nickname.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/nickname`

/nickname/{nickname}

Function	Gets the Nickname of the device.
Method	Get
Response	Nickname.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/nickname/{nickname}`

/ping

Function	A simple way to ping the application.
Method	Get
Response	Pong as a response.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/ping`

/restart

Function	Reboot the camera.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/restart`

/romversion

Function	Gets the ROM version number.
Method	Get
Response	The ROM version.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/romversion`

/serialnumber

Function	Gets the camera serial number.
Method	Get
Response	The serial number of the camera.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/serialnumber`

/model

Function	Gets the camera model.
Method	Get
Response	The model of the camera.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/model`

/generation

Function	Gets the camera model.
Method	Get
Response	The model of the camera.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/generation`

/storage

Function	Remaining storage.
Method	Get
Response	Storage in GB.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/device/storage`

Application Details

/restart

Function	Restart the software on the Rayfin device.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/app/restart`

/ping

Function

A simple way to ping the application.

(This command has been moved to the Device Details section)

Method

Get

Response

Pong as a response.

Example

CODE

$ curl http://IP_ADDRESS:8080>/api/app/ping

/reboot

Function	Restart the camera.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/app/reboot`

/version

Function	Gets the app version number.
Method	Get
Response	The app version.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/app/version`

/firmwareversion

Function

Gets the ROM version number.

(This command has been moved to the Device Details section)

Method

Get

Response

The ROM version.

Example

CODE

$ curl http://IP_ADDRESS:8080>/api/app/firmwareversion

/serialnumber

Function

Gets the camera serial number.

(This command has been moved to the Device Details section)

Method

Get

Response

The serial number of the camera.

Example

CODE

$ curl http://IP_ADDRESS:8080>/api/app/serialnumber

/romversion

Function

Gets the ROM version number.

(This command has been moved to the Device Details section)

Method

Get

Response

The ROM version.

Example

CODE

$ curl http://IP_ADDRESS:8080>/api/app/romversion

Lens Details

/focus/limit/{farLimit}/{nearLimit}

Function	Set focus limit in AF.
Method	Get
Response	Set limit for near.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/focus/limit/{farLimit}/{nearLimit}`

/focus/auto

Function	Enable auto focus on the lens.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/focus/auto`

/focus/manual

Function	Enable manual focus on the lens.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/focus/manual`

/focus/far

Function	Focus the lens far.
Method	Get
Response	The lens position.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/focus/far`

/focus/near

Function	Focus the lens near.
Method	Get
Response	The lens position.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/focus/near`

/focus/limit

Function	Gets the AF limits set in the sysProp.
Method	Get
Response	Far and near values.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/focus/limit`

/focus

Function	Get the current focus value.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/focus`

/type

Function	Get the lens type.
Method	Get
Response	The lens type.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/type`

/zoom

Function	Get the zoom level.
Method	Get
Response	Current zoom position.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/zoom`

/focus/isauto

Function	Gets a value indicating whether the lens is in auto focus.
Method	Get
Response	True if the lens is in auto focus. False if it's in auto focus.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/focus/isauto`

/ois/isenabled

Function	Get a value indicating whether OIS is enabled.
Method	Get
Response	True if OIS is enabled.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/ois/isenabled`

/ois/disable

Function	Disable OIS.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/ois/disable`

/ois/enable

Function	Enable OIS.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/ois/enable`

/pan/left

Function	Activates a pan left action.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/pan/left`

/pan/left/{speed}

Function	Activates a pan left with a specific speed.
Method	Get
Response	given speed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/pan/left/{speed}`

/pan/right

Function	Activates a pan right action.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/pan/right`

/pan/right/{speed}

Function	Activates a pan right action and specifies the speed.
Method	Get
Response	The speed as a percentage integer.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/pan/right/{speed}`

/focus/{value}

Function	Set the focus value.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/focus/{value}`

/ptz/stop

Function	Stops all continuous PTZ actions.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/ptz/stop`

/tilt/down/{speed}

Function	Activates a tilt down action and specifies the speed.
Method	Get
Response	The speed as a percentage integer.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/tilt/down/{speed}`

/tilt/down/

Function	Activates a tilt down action and specifies the speed.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/tilt/down/`

/tilt/up/{speed}

Function	Activates a tilt up action and specifies the speed.
Method	Get
Response	The speed as a percentage integer.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/tilt/up/{speed}`

/tilt/up

Function	Activates a tilt up action and specifies the speed.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/tilt/up`

/zoom/in

Function	Zoom the lens in.
Method	Get
Response	Current zoom position.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/zoom/in`

/zoom/out

Function	Zoom the lens out.
Method	Get
Response	Current zoom position.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/zoom/out`

/zoom/{value}

Function	Set the zoom level.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/lens/zoom/{value}`

File Server Details

/download/{fileName}

Function	Downloads the specified file.
Method	Get
Response	True if the file exists and could be read.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/download/{fileName}`

/download/{dir1}/{fileName}

Function	Download the specified file.
Method	Get
Response	True if the file file exists and was able to be retrieved.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/download/{dir1}/{fileName}`

/getfileinfo

Function	Get the specified file info.
Method	Post
Body	CODE `{ "Path" : "path/filename" }`
Response	A tuple containing the filename, last modified date time, and file size in bytes.
Explanation	Using the command: CODE `http://<ip>:8080/api/still/take` Take an image and get the output path. Insert the path/filename into the POST template to get the file information. The output would look like: CODE `{ "Item1": "20230802-222245.jpg", "Item2": "1601-01-02T19:28:22", "Item3": 5194046, "System.Runtime.CompilerServices.ITuple.Length": null, "System.Runtime.CompilerServices.ITuple.Item": null }` Item 1 = Filename Item 2 = Date and time the file was created Item 3 = Filename size Item 4 = ? (Pending, request posted on RM-172) Item 5 = ? (Pending, request posted on RM-172)
Example	Example 1 CODE `{ "Path" : "/mnt/expand/64180671-0e95-4e34-9381-0780ce582c9c/DCIM/ProjectName-Still/20230802-222245.jpg" }` Output CODE `$ curl -X POST http://<ip>:<port>/api/files/getfileinfo -H 'Content-Type: application/json' -d '{ "Path" : "/mnt/expand/64180671-0e95-4e34-9381-0780ce582c9c/DCIM/ProjectName-Still/20230802-222245.jpg" }'`

/download/{dir1}/{dir2}/{fileName}

Function	Download the specified file.
Method	Get
Response	True if the file file exists and was able to be retrieved.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/download/{dir1}/{dir2}/{fileName}`

/download/{dir1}/{dir2}/{dir3}/{fileName}

Function	Download the specified file.
Method	Get
Response	True if the file file exists and was able to be retrieved.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/download/{dir1}/{dir2}/{dir3}/{fileName}`

/download/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}

Function	Download the specified file.
Method	Get
Response	True if the file file exists and was able to be retrieved.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/download/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}`

/download/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}

Function	Download the specified file.
Method	Get
Response	True if the file file exists and was able to be retrieved.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/download/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}`

/downloadfolder/{folderName}

Function	Downloads the specified file.
Method	Get
Response	True if the file exists and could be read.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/downloadfolder/{folderName}`

/downloadthumbnail/{dir1}/{fileName}

Function	Download the specified thumbnail.
Method	Get
Response	True if the file file exists and was able to be retrieved. The generated thumbnail size is 110x80 pixels.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/downloadthumbnail/{dir1}/{fileName}`

/downloadthumbnail/{dir1}/{dir2}/{fileName}

Function	Download the specified thumbnail.
Method	Get
Response	True if the file file exists and was able to be retrieved.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/downloadthumbnail/{dir1}/{dir2}/{fileName}`

/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}

Function	Download the specified thumbnail.
Method	Get
Response	True if the file file exists and was able to be retrieved.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}`

/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}

Function	Download the specified thumbnail.
Method	Get
Response	True if the file file exists and was able to be retrieved.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}`

/downloadthumbnail/{fileName}

Function	Downloads the specified thumbnail.
Method	Get
Response	True if the file exists and could be read.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/downloadthumbnail/{fileName}`

/list

Function	List files in the root directory.
Method	Get
Response	A list of the files in the specified directory.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/list`

/list/{dir1}

Function	List files in the specified directory of depth 1.
Method	Get
Response	Directory 1.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/list/{dir1}`

/list/{dir1}/{dir2}

Function	List files in the specified directory of depth 2.
Method	Get
Response	Directory 2.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/list/{dir1}/{dir2}`

/list/{dir1}/{dir2}/{dir3}

Function	List files in the directory of depth 3.
Method	Get
Response	Directory 3.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/list/{dir1}/{dir2}/{dir3}`

/list/{dir1}/{dir2}/{dir3}/{dir4}

Function	List files in the directory of depth 4.
Method	Get
Response	Directory 4.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/list/{dir1}/{dir2}/{dir3}/{dir4}`

/list/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}

Function	List files in the directory of depth 5.
Method	Get
Response	Directory 5.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/list/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}`

/wlist

Function	List files in the root directory.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/wlist`

/wlist/{dir1}

Function	List files in the directory depth 1.
Method	Get
Response	Directory 1.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/wlist/{dir1}`

/wlist/{dir1}/{dir2}

Function	List files in the directory depth 2.
Method	Get
Response	Directory 2.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/wlist/{dir1}/{dir2}`

/wlist/{dir1}/{dir2}/{dir3}

Function	List files in the directory depth 3.
Method	Get
Response	Directory 3.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/wlist/{dir1}/{dir2}/{dir3}`

/wlist/{dir1}/{dir2}/{dir3}/{dir4}

Function	List files in the directory depth 4.
Method	Get
Response	Directory 4.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/wlist/{dir1}/{dir2}/{dir3}/{dir4}`

/wlist/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}

Function	List files in the directory depth 5.
Method	Get
Response	Directory 5.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/files/wlist/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}`

White Balance Details

/bluechannel/down

Function	Blue channel Decrement.
Method	Get
Response	Blue channel value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/bluechannel/down`

/bluechannel/up

Function	Blue channel increment.
Method	Get
Response	Blue channel value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/bluechannel/up`

/bluechannel

Function	Get blue channel value.
Method	Get
Response	Blue channel value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/bluechannel`

/greenchannel

Function	Get green channel value.
Method	Get
Response	Green channel value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/greenchannel`

/redchannel

Function	Get red channel value.
Method	Get
Response	Red channel value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/redchannel`

/mode

Function	White balance mode 0=manual or 1=auto.
Method	Get
Response	White balance mode.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/mode`

/greenchannel/down

Function	Green channel Decrement.
Method	Get
Response	Green channel value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/greenchannel/down`

/greenchannel/up

Function	Green channel increment.
Method	Get
Response	Green channel value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/greenchannel/up`

/redchannel/down

Function	Red channel Deccrement.
Method	Get
Response	Red channel value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/redchannel/down`

/redchannel/up

Function	Red channel increment.
Method	Get
Response	Red channel value.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/redchannel/up`

/bluechannel/{value}

Function	Update the blue channel.
Method	Get
Response	Value of blue channel.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/bluechannel/{value}`

/greenchannel/{value}

Function	Update the green channel.
Method	Get
Response	Value of green channel.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/greenchannel/{value}`

/redchannel/{value}

Function	Update the red channel.
Method	Get
Response	Value of red channel.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/redchannel/{value}`

/mode/{mode}

Function	Updates the white balance mode. Mode options include “Manual” and “Auto”.
Method	Get
Response	mode ID.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/whitebalance/mode/{mode}`

RTSP Details

/get

Function	Get the current configuration.
Method	Get
Response	All the configuration.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/rtsp/get`

/update

Function	Update the streaming settings.
Method	Post
Body	CODE `{ "Framerate":"", "Bitrate":"", "Resolution":"" }` **Your can provide one of the three possible keys/arguments. If one is left out, the default is used instead.
Response	A representing the asynchronous operation.
Explanation	Defaults Framerate = 30 Bitrate = 10000 Resolution = 1920x1080 (1080p) Available Frame Rate Any Available Bitrate 1000 to 100,000 Available Resolution 640 x 480 (SD) 1280 x 720 (720p) 1920x1080 (1080p) 3840 x 2160 (4K)
Example	Example 1 CODE `{ "Framerate":"30", "Bitrate":"1000", "Resolution":"1920x1080" }` Output CODE `$ curl -X POST http://<ip>:<port>/api/rtsp/update -H 'Content-Type: application/json' -d '{ "Framerate":"30", "Bitrate":"2000", "Resolution":"1920x1080" }'` Example 2 CODE `{ "Framerate":"30", "Bitrate":"2000", }` Output CODE `$ curl -X POST http://<ip>:<port>/api/rtsp/update -H 'Content-Type: application/json' -d '{ "Framerate":"30", "Bitrate":"2000" }'`

SkateMK2/Laser Details

/ison

Function	Gets a value indicating whether the cameras lasers are on.
Method	Get
Response	True if the Rayfin lasers are on.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/laser/ison`

/isinverted

Function	Gets a value indicating whether the cameras lasers are inverted.
Method	Get
Response	True if the Rayfin lasers are on.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/laser/isinverted`

/invert/{val}

Function	Invert laser controls.
Method	Get
Response	True or false.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/laser/invert/{val}`

/isattached

Function	Gets a value indicating whether the camera has lasers.
Method	Get
Response	True if the Rayfin has lasers.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/laser/isattached`

/off

Function	Turn the lasers off.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/laser/off`

/on

Function	Turn the lasers on.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/laser/on`

State Details

/api/state

Function	Get the state of the camera.
Method	Get
Response	State of the camera.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/state`

Network Details

/connectionspeed

Function	Get the network link speed.
Method	Get
Response	Link speed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/network/connectionspeed`

/enabledhcp

Function	Enable DHCP on the camera.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/network/enabledhcp`

/staticfallbackseconds/{seconds}

Function	Change the DHCP delay before falling back to static IP. (Default value is 30 seconds)
Method	Get
Response	The number of seconds to delay before falling back to static IP.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/network/staticfallbackseconds/{seconds}`

/enablestaticip

Function	Enable static IP.
Method	Post
Body	CODE `{ "IPAddress":"#.#.#.#", "Gateway":"#.#.#.#", "DNS1":"#.#.#.#", "DNS2":"#.#.#.#", "SubnetMask":"#.#.#.#", }`
Response	A representing the asynchronous operation.
Explanation	Sets the IP address on the Rayfin to a static address.
Example	Example 1 CODE `{ "IPAddress":"192.168.2.20", "Gateway":"192.168.2.1", "DNS1":"192.168.2.1", "DNS2":"8.8.8.8", "SubnetMask":"255.255.255.0" }` Command CODE `$ curl -X POST http://IP_ADDRESS:8080>/api/network/enablestaticip -H 'Content-Type: application/json' -d '{ "IPAddress":"192.168.1.20", "Gateway":"192.168.2.1", "DNS1":"192.168.2.1", "DNS2":"8.8.8.8", "SubnetMask":"255.255.255.0" }'`

/enablestaticip/{ip}/{gateway}/{dns1}/{dns2}/{subnetmask}

Function	Enable static IP.
Method	Get
Response	Subnet mask to use.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/network/enablestaticip/{ip}/{gateway}/{dns1}/{dns2}/{subnetmask}`

/get

Function	Get the network state.
Method	Get
Response	The current network state.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/network/get`

Pan/Tilt Details

/pan/left

Function	Activates a pan left action.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/pantilt/pan/left`

/pan/right

Function	Activates a pan right action.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/pantilt/pan/right`

/pan/to/{degrees}

Function	Activates a pan right action.
Method	Get
Response	Angle to pan to.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/pantilt/pan/to/{degrees}`

/stop

Function	Stops all continuous PTZ actions.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/pantilt/stop`

/tilt/down/

Function	Activates a tilt down action and specifies the speed.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/pantilt/tilt/down/`

/tilt/up

Function	Activates a tilt up action and specifies the speed.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/pantilt/tilt/up`

/tilt/to/{degrees}

Function	Activates a tilt right action.
Method	Get
Response	Angle to tilt to.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/pantilt/tilt/to/{degrees}`

/state

Function	Activates a tilt up action and specifies the speed.
Method	Get
Response	A dictionary of values.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/pantilt/state`

Document Purpose

API Calls Index

Aux Input Commands UPDATED

Exposure Commands UPDATED

Time Commands

Stills Commands

Aquorea MK3/Led Commands

Device Commands

Application Commands

Lens Commands

File Server Commands

White Balance Commands

RTSP Commands

SkateMK2/Laser Commands

State Commands

Network Commands

Pan/Tilt Commands

API Calls

Aux Input Details

/device/{input}

/{input}

/{auxInput}/{auxDevice}

/{auxInput}/{auxDevice}/{baudRate}/{serialStandard}

Exposure Details

/auto

/manual

/ev/down

/ev/up

/ev

/isauto

/iso

/shutter

/iso/down

/iso/up

/shutter/islocked

/shutter/lock

/shutter/lock/{value}

/framerate/lock/{value}

/ev/{value}

/iso/{value}

/shutter/limit/set/{limit}

/shutter/down

/shutter/up

/shutter/unlock

/framerate/unlock

/shutter/{value}

Time Details

/ntp/enable

/ntp/disable

/ntp/drift

/ntp/driftthreshold

/ntp/server

/datetime

/timezone

/ntp/isenabled

/ntp/sync

/ntp/driftthreshold/{value}

/ntp/server/{server}

/datetime/{millis}

/timezone

Stills Details

/hascapturefailed

/reset

/jpegquality

/pathtemplate

/isstillrequestpending

/jpegquality/{value}

/pathtemplate

/take

/takeanddispose

/takeandget

/takeandsave

/takeandsave

Aquorea MK3 LED Details

/strobe/disable

/strobe/enable

/isattached

/lamp/ison

/strobe/isenabled

/lamp/off