Settings
getSettingsAudio
get
postSettingsAudio
post
getSettingsAudioDsp
get
postSettingsAudioDsp
post
getSettingsAudioDspHdmi
get
postSettingsAudioDspHdmi
post
getSettingsAudioDspLine
get
postSettingsAudioDspLine
post
getSettingsAudioDspMic
get
postSettingsAudioDspMic
post
getSettingsAudioStereo
get
postSettingsAudioStereo
post
getSettingsAudioStereoDelay
get
postSettingsAudioStereoDelay
post
getSettingsAudioStereoVolume
get
postSettingsAudioStereoVolume
post
getSettingsAudioStream
get
postSettingsAudioStream
post
getSettingsAudioStreamEnabled
get
postSettingsAudioStreamEnabled
post
getSettingsAudioStreamForced
get
postSettingsAudioStreamForced
post
getSettingsDevice
get
postSettingsDevice
post
getSettingsDeviceId
get
postSettingsDeviceId
post
getSettingsDeviceLeds
get
postSettingsDeviceLeds
post
getSettingsDeviceName
get
postSettingsDeviceName
post
getSettingsDeviceNetwork
get
postSettingsDeviceNetwork
post
getSettingsDeviceNetworkDns
get
postSettingsDeviceNetworkDns
post
getSettingsDeviceNetworkGateway
get
postSettingsDeviceNetworkGateway
post
getSettingsDeviceNetworkIpaddress
get
postSettingsDeviceNetworkIpaddress
post
getSettingsDeviceNetworkMode
get
postSettingsDeviceNetworkMode
post
getSettingsDeviceNetworkMulticast
get
postSettingsDeviceNetworkMulticast
post
getSettingsDeviceNetworkNetmask
get
postSettingsDeviceNetworkNetmask
post
getSettingsDeviceNetworkTimeserver
get
postSettingsDeviceNetworkTimeserver
post
getSettingsDevicePowersave
get
postSettingsDevicePowersave
post
getSettingsDevicePowersaveEnabled
get
postSettingsDevicePowersaveEnabled
post
getSettingsDevicePowersaveTimeout
get
postSettingsDevicePowersaveTimeout
post
getSettingsFlux
get
postSettingsFlux
post
getSettingsImagepull
get
postSettingsImagepull
post
getSettingsSerial
get
postSettingsSerial
post
getSettingsSerialMode
get
postSettingsSerialMode
post
getSettingsSerialSpeed
get
postSettingsSerialSpeed
post
getSettingsSerialSpeedBaud
get
postSettingsSerialSpeedBaud
post
getSettingsSerialSpeedDatabits
get
postSettingsSerialSpeedDatabits
post
getSettingsSerialSpeedParity
get
postSettingsSerialSpeedParity
post
getSettingsSerialSpeedStopbits
get
postSettingsSerialSpeedStopbits
post
getSettingsSwitchplease
get
postSettingsSwitchplease
post
getSettingsUsb
get
postSettingsUsb
post
getSettingsUsbEnabled
get
postSettingsUsbEnabled
post
getSettingsUsbTouchscreen
get
postSettingsUsbTouchscreen
post
getSettingsVideo
get
postSettingsVideo
post
getSettingsVideoCodec
get
postSettingsVideoCodec
post
getSettingsVideoHdcp
get
postSettingsVideoHdcp
post
getSettingsVideoHdcpAlways1X
get
postSettingsVideoHdcpAlways1X
post
getSettingsVideoHdcpAlways22
get
postSettingsVideoHdcpAlways22
post
getSettingsVideoHdcpReject
get
postSettingsVideoHdcpReject
post
getSettingsVideoHdr
get
postSettingsVideoHdr
post
getSettingsVideoScaler
get
postSettingsVideoScaler
post
getSettingsVideoStream
get
postSettingsVideoStream
post
getSettingsVideoStreamEnabled
get
postSettingsVideoStreamEnabled
post
getSettingsVideoStreamMaxbandwidth
get
postSettingsVideoStreamMaxbandwidth
post
getSettingsVideowall
get
postSettingsVideowall
post
getSettingsVideowallBezel
get
postSettingsVideowallBezel
post
getSettingsVideowallLayout
get
postSettingsVideowallLayout
post
getSettingsVideowallRotate
get
postSettingsVideowallRotate
post
getSettingsVideowallRotateClockwise
get
postSettingsVideowallRotateClockwise
post
getSettingsVideowallRotateMirror
get
postSettingsVideowallRotateMirror
post
getSettingsVideowallShift
get
postSettingsVideowallShift
post
getSettingsVideowallShiftHorizontal
get
postSettingsVideowallShiftHorizontal
post
getSettingsVideowallShiftVertical
get
postSettingsVideowallShiftVertical
post
getSettingsVideowallZoom
get
postSettingsVideowallZoom
post
getSettingsVideowallZoomHorizontal
get
postSettingsVideowallZoomHorizontal
post
getSettingsVideowallZoomVertical
get
postSettingsVideowallZoomVertical
post
Models
details
detailsAudio
detailsAudioHDMI
detailsAudioStereoDelay
detailsAudioStereoVolume
detailsChannel
detailsDevice
detailsDeviceFirmware
detailsDeviceFirmwareDate
detailsDeviceFirmwareUpdate
detailsDeviceFirmwareUpdateETA
detailsDeviceFirmwareUpdateMessage
detailsDeviceFirmwareUpdateProgress
detailsDeviceFirmwareUpdateResult
detailsDeviceFirmwareUpdateStatus
detailsDeviceFirmwareVersion
detailsDeviceModel
detailsDeviceNetwork
detailsDeviceNetworkIPAddress
detailsDeviceNetworkMAC
detailsDeviceNetworkMTU
detailsDeviceNetworkNetmask
detailsDeviceNetworkSpeed
detailsDeviceStatus
detailsDeviceTime
detailsDeviceUptime
detailsEDID
detailsEDIDBytes
detailsImagepull
detailsSystem
detailsSystemRX
detailsSystemTX
detailsVideo
detailsVideoHDCP
detailsVideoHDR
detailsVideoResolution
detailsVideoScaler
detailsVideowall
detailsVideowallLayout
error
getAudio
getAudioDsp
getAudioDspHdmi
getAudioDspLine
getAudioDspMic
getAudioStereo
getAudioStereoDelay
getAudioStereoVolume
getAudioStream
getAudioStreamEnabled
getAudioStreamForced
getDevice
getDeviceName
getDeviceNetwork
getDeviceNetworkDNS
getDeviceNetworkGateway
getDeviceNetworkIPAddress
getDeviceNetworkMode
getDeviceNetworkMulticast
getDeviceNetworkNetmask
getDeviceNetworkTimeserver
getDevicePowersave
getDevicePowersaveEnabled
getDevicePowersaveTimeout
getFlux
getImagePull
getSerial
getSerialMode
getSerialSpeed
getSerialSpeedBaud
getSerialSpeedDatabits
getSerialSpeedParity
getSerialSpeedStopbits
getSwitchplease
getUsb
getUsbEnabled
getUsbTouchscreen
getVideoCodec
getVideoHdcp
getVideoHdcpAlways1x
getVideoHdcpAlways22
getVideoHdcpReject
getVideoHdr
getVideoScaler
getVideoStream
getVideoStreamEnabled
getVideoStreamMaxbandwidth
getVideowall
getVideowallBezel
getVideowallLayout
getVideowallRotate
getVideowallRotateClockwise
getVideowallRotateMirror
getVideowallShift
getVideowallShiftHorizontal
getVideowallShiftVertical
getVideowallZoom
getVideowallZoomHorizontal
getVideowallZoomVertical
setAudio
setAudioDsp
setAudioDspHdmi
setAudioDspLine
setAudioDspMic
setAudioStereo
setAudioStereoDelay
setAudioStereoVolume
setAudioStream
setAudioStreamEnabled
setAudioStreamForced
setDevice
setDeviceId
setDeviceLeds
setDeviceName
setDeviceNetwork
setDeviceNetworkDNS
setDeviceNetworkGateway
setDeviceNetworkIPAddress
setDeviceNetworkMode
setDeviceNetworkMulticast
setDeviceNetworkNetmask
setDeviceNetworkTimeserver
setDevicePowersave
setDevicePowersaveEnabled
setDevicePowersaveTimeout
setFlux
setImagepull
setSerial
setSerialMode
setSerialSpeed
setSerialSpeedBaud
setSerialSpeedDatabits
setSerialSpeedParity
setSerialSpeedStopbits
setSwitchplease
setUsb
setUsbEnabled
setUsbTouchscreen
setVideoCodec
setVideoHdcp
setVideoHdcpAlways1x
setVideoHdcpAlways22
setVideoHdcpReject
setVideoHdr
setVideoScaler
setVideoStream
setVideoStreamEnabled
setVideoStreamMaxbandwidth
setVideowall
setVideowallBezel
setVideowallLayout
setVideowallRotate
setVideowallRotateClockwise
setVideowallRotateMirror
setVideowallShift
setVideowallShiftHorizontal
setVideowallShiftVertical
setVideowallZoom
setVideowallZoomHorizontal
setVideowallZoomVertical

Just Add Power HTTP API

  • Version: 1.1.2
  • Host: 1.1.1.1/cgi-bin/api
  • Protocols: http
  • Accepts: application/json
  • Responds With: application/json

justAPI

Requires

justOS Firmware Version: B1.1.0 (or later)

Overview

Just Add Power provides a RESTful HTTP API to interface with and control our 2GΩ/3G and 3G HD/IP products.

Each Just Add Power device’s IP address is the HOST for the API and is accessed as follows

http://HOST/cgi-bin/api/URI

NOTE: justAPI responses are enveloped JSON with “data” attached to successful responses, and “error” attached to failed requests.

Example:

curl -X GET http://192.168.100.130/cgi-bin/api/details/device/firmware/version

Returns:

{"data":"B1.0.0"}

Structure

The API is broken down into three major categories:

  1. command
  2. details
  3. settings

Command

  • HTTP Method: POST
  • Accept Content-Type: application/json text/plain
  • Return Content-Type: application/json

Have an immediate effect on live device behavior.

Commands cannot be sent as bulk JSON changes to the target device and must address the specific API endpoint URI.

Details

  • HTTP Method: GET
  • Return Content-Type: application/json

Report the live status of read-only values on the device.

Details can be retrieved in bulk JSON from the device by targetting any parent URI. Bulk queries will take longer to complete than specific endpoint queries.

Settings

  • HTTP Method: GET POST
  • Accept Content-Type: application/json text/plain
  • Return Content-Type: application/json

Changes device behavior after a rebooot

NOTE!: Settings require a save command to commit changes to memory

Settings can be posted and retrieved in bulk JSON from the device by targetting any parent URI. Bulk posts/queries will take longer to complete than specific URI endpoint queries.

Special Meanings of false and null

false and null are special justAPI indicators

  • /details
    • GET =>
      • false - the resource is valid, but is either disabled or currently unavailable
      • null - the resource is not valid for this hardware
  • /settings
    • GET =>
      • false - the resource is valid, but is either disabled or not set
      • null - the resource is not valid for this hardware
    • SET =>
      • false - valid only with resources that accept boolean
      • null - clears any current settings applied to a valid resource
  • /command
    • SET =>
      • false - valid only with resources that accept boolean
      • null - invalid for all commands