Devices

Device Object shows top level information about PDU power, energy, sensors, and etc. Attributes will differ depending on it's models.

Endpoints

endpoint

GET    /api/device                 Returns object describing top level device information

Device Object

Key	Type	Description
numBanks	number	Number of banks: a section of outlets on a specific circuit
numOutlets	number	Number of outlets total
numInlets	number	Number of inlets. Either 1 or 2
inletPlug	string	Inlet Plug receptacle/plug. If multiple inlets, both are same plug type
outletPwrMeasurementsSupported	boolean	When true, each outlet can measure current draw in amps
outletSwitchingSupported	boolean	When true, each outlet can switch on or off with a relay
enclosureSerialNumber	string	Unique ID for PDU Enclosure.
modelNumber	string	Specific PDU model number
inletConfig	string	Either "standard", "dualcircuit", or "ats"
formFactor	string	Either "0U", "1U", or "2U"
controllerSerialNumber	number	Serial Number of SynLink Controller Module
controllerFirmwareVersion	string	Firmware version for controller
controllerHardwareVersion	string	Hardware version for controller
phase	string	Either "Single Phase", "Three Phase Delta", or "Three Phase Wye"
circuitBreakerProtection	boolean	True if circuit breaker protection exists
uptime	number	Number of seconds the PDU has been on.
time	string	Time in ISO8601 String Format.

JSON

{
  "numBanks": 3,
  "numOutlets": 36,
  "numInlets": 1,
  "inletPlug": "L21-30P",
  "outletPwrMeasurementsSupported": true,
  "outletSwitchingSupported": true,
  "enclosureSerialNumber": 1024122712,
  "modelNumber": "SP-3001CA-HA",
  "inletConfig": "standard",
  "formFactor": "0U",
  "controllerSerialNumber": 1360604425,
  "controllerFirmwareVersion": "1.0.3",
  "phase": "Single Phase",
  "controllerHardwareVersion": "1.0.0",
  "circuitBreakerProtection": true,
  "uptime": 19284619
}

Get Device Info

Retrieve PDU device information.

endpoint

GET    /api/device      Returns object describing top level device information

Example Request

cURL

curl 'http://192.168.1.100/api/device' \
--header 'Authorization: Bearer j2d36cG2ciHKDDqFc3k'

Response Body

JSON

{
  "numBanks": 3,
  "numOutlets": 36,
  "numInlets": 1,
  "inletPlug": "L21-30P",
  "outletPwrMeasurementsSupported": true,
  "outletSwitchingSupported": true,
  "enclosureSerialNumber": "1024122712",
  "modelNumber": "SP-3001CA-HA",
  "inletConfig": "standard",
  "formFactor": "0U",
  "controllerSerialNumber": "1921218731",
  "controllerFirmwareVersion": "0.1.2",
  "controllerHardwareVersion": "1.0.1",
  "circuitBreakerProtection": true,
  "uptime": 19284619
}