Inlets

Inlets show information about inlet configuration and energy consumption if relevant.

Endpoints

endpoint

GET    /api/inlets                             Returns list of all inlets
PUT    /api/inlets/:inlet_id                   Modifies individual inlet

Inlet Object

Key	Type	Description	Availability
id	string	Unique identifier for the inlet	All PDUs
inletType	string	Inlet type: "single", "dual", or "ats"	All PDUs
inletPlug	string	Connector type used for this inlet (e.g., "NEMA L6-20P")	All PDUs
inletName	string	User-defined name for the inlet	All PDUs
inletEnergyAccumulation	number	Total energy accumulated in kWh. Same value shown across all inlets if multiple.	Select PDUs
inletPhase	string	"Single Phase" or "Three Phase"	All PDUs
inletPowerFactor	number	Power factor value	3-Phase & Select Single phase PDUs
threePhaseBalance	string	Percent balance across 3-phase lines	3-Phase only
inletLines	array	Array of 3 line objects with line, id, and currentRms (in Amps)	3-Phase only
inletCurrentRms	number	RMS current draw on the inlet (Amps)	Most PDUs
inletVoltageRms	number	RMS voltage on the inlet (Volts)	Select PDUs
inletLineFrequency	number	Frequency of the inlet line (Hz)	Select PDUs
inletActivePower	number	Active power (Watts)	Select PDUs
inletApparentPower	number	Apparent power (VA)	Select PDUs
inletLineConfiguration	string	Configuration such as "L-L"	Select PDUs
atsInletId	string	"A" or "B" — matches physical inlet label	ATS PDUs only
atsInletActive	boolean	true if this inlet is currently powering outlets	ATS PDUs only
atsInletReady	boolean	true if this inlet has voltage available	ATS PDUs only

JSON

{
  "id": "17374353",
  "inletType": "ats",
  "inletPlug": "NEMA L6-20P",
  "inletName": "NEMA L6-20P Inlet",
  "inletEnergyAccumulation": 89.03,
  "inletPhase": "Single Phase",
  "inletPowerFactor": 0.8,
  "inletCurrentRms": 4.2,
  "inletVoltageRms": 202.4,
  "inletLineFrequency": 59.9,
  "inletActivePower": 11,
  "inletApparentPower": 10,
  "inletLineConfiguration": "L-L",
  "atsInletId": "A",
  "atsInletActive": true,
  "atsInletReady": true
}

List All Inlets

Returns a list of all outlets that within any connected banks. Only available if outletSwitchingSupported or outletMeteringSupported are true.
Return a list of all inlets. Maximum 2 inlets possible. "ats" and "dual" for inletType configurations will have 2 inlets. inletType: "standard" will always have a single inlet.

endpoint

GET    /api/inlets        Returns list of all inlets

Example Request

cURL

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

Response (Varies on configuration)

JSON

[
  {
    "id": "17374353",
    "inletType": "single",
    "inletPlug": "NEMA L21-30P",
    "inletName": "NEMA L6-20P Inlet",
    "inletLineConfiguration": "L-L",
    "inletEnergyAccumulation": 89,
    "inletCurrentRms": 4.2,
    "inletVoltageRms": 202.4,
    "inletLineFrequency": 59.9,
    "inletPowerFactor": 0.8,
    "inletActivePower": 11,             
    "inletApparentPower": 10
  }
]

Expected reponse is an array of Inlet Object(s)

Modify Inlet

Endpoint to modify Outlet information, including the relay state to turn outlet on and off.

endpoint

PUT    /api/inlets/:inlet_id                   Modifies individual inlet

Request

Follows Authentication Scheme.
All request parameters are optional, but at least one is required.

JSON

{
  "inletName": "Primary Line Input",
  "inletEnergyAccumulation": 0
}

inletName optional
Name string up to 100 characters.

inletEnergyAccumulation optional
Only value accepted is 0. 0 will reset energy accumulation back to 0. Resetting energy accumulation for any inlet will reset for all inlets.

Example Request

cURL

curl 'http://192.168.1.100/api/inlets/17374354' \
  --header 'Authorization: Bearer j2d36cG2ciHKDDqFc3k' \
  --data '{ "inletName":"Primary Line Input", "inletEnergyAccumulation": 0 }'

Response

Expected response is an updated Inlet Object. Varies with configuration.

JSON

{
  "id": "17374353",
  "inletType": "single",
  "inletPlug": "NEMA L6-20P",
  "inletName": "Primary Line Input",
  "inletLineConfiguration": "L-L",
  "inletEnergyAccumulation": 0,
  "inletCurrentRms": 4.2,
  "inletVoltageRms": 202.4,
  "inletLineFrequency": 59.9,
  "inletPowerFactor": 0.8,
  "inletActivePower": 11,        
  "inletApparentPower": 10
}