--- updatedAt: 2026-04-29T00:49:36.000Z agentTools: projectIndex: https://synaccess.readme.io/llms.txt --- # Get Device Details Retrieve detailed information for a single device, including live outlet, inlet, bank, sensor, and event data when available. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Cloud.Synaccess", "version": "1.3" }, "servers": [ { "url": "https://cloud.synaccess.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "authorization", "in": "header", "x-default": "Bearer" } }, "schemas": { "DeviceSummary": { "type": "object", "properties": { "deviceName": { "type": "string", "description": "User-assigned name for the PDU." }, "connectionState": { "type": "string", "description": "Current cloud connectivity state." }, "numBanks": { "type": "integer", "format": "int32", "description": "Number of outlet banks available on the device." }, "numOutlets": { "type": "integer", "format": "int32", "description": "Total number of controllable outlets." }, "numDryContactRelays": { "type": "integer", "format": "int32", "description": "Number of dry contact relays included with the controller." }, "numInlets": { "type": "integer", "format": "int32", "description": "Number of power inlets exposed by the chassis." }, "inletPlug": { "type": "string", "description": "Physical plug/receptacle type for the inlet." }, "outletPwrMeasurementsSupported": { "type": "boolean", "description": "True when the device reports per-outlet power telemetry." }, "inletCurrentSupported": { "type": "boolean", "description": "True when aggregate inlet current telemetry is supported." }, "outletSwitchingSupported": { "type": "boolean", "description": "True when outlets can be remotely switched." }, "inletEnergySupported": { "type": "boolean", "description": "True when cumulative inlet energy readings are available." }, "enclosureSerialNumber": { "type": "integer", "format": "int64", "description": "Unique enclosure serial number assigned to the PDU." }, "modelNumber": { "type": "string", "description": "Commercial model identifier." }, "inletConfig": { "type": "string", "description": "Inlet wiring configuration (for example \"standard\")." }, "formFactor": { "type": "string", "description": "Mechanical chassis form factor (for example \"1U\" or \"Compact\")." }, "controllerSerialNumber": { "type": "integer", "format": "int64", "nullable": true, "description": "Serial number of the SynLink controller module. May be null for legacy hardware." }, "controllerFirmwareVersion": { "type": "string", "description": "Currently running controller firmware version string." }, "controllerHardwareVersion": { "type": "string", "description": "Hardware revision for the controller module." }, "phase": { "type": "string", "description": "Power phase configuration." }, "circuitBreakerProtection": { "type": "boolean", "description": "True when the device includes integrated circuit breaker protection." }, "lastFwUpdateStatus": { "type": "string", "description": "Last reported firmware update status combined with epoch timestamp." }, "update_pending_firmware": { "type": "string", "nullable": true, "description": "Version string queued for installation, when applicable." }, "update_initiated_time": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp when the pending firmware update was initiated." }, "controllerFirmwareVersionUpdatedAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp of the most recent controller firmware version change." }, "lastHeard": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp of the last heartbeat received from the controller." } } }, "DeviceDetail": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeviceSummary" }, { "type": "object", "properties": { "ipAddress": { "type": "string", "nullable": true, "description": "Last known IP address reported by the controller." }, "cloudPostIntervalMs": { "type": "integer", "format": "int32", "nullable": true, "description": "Polling interval (milliseconds) used when the controller posts telemetry to the cloud." }, "outlets": { "type": "array", "items": { "$ref": "#/components/schemas/Outlet" } }, "inlets": { "type": "array", "items": { "$ref": "#/components/schemas/Inlet" } }, "banks": { "type": "array", "items": { "$ref": "#/components/schemas/Bank" } }, "sensors": { "type": "array", "items": { "type": "object" } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceEvent" } } } } ] }, "Outlet": { "type": "object", "properties": { "connectionState": { "type": "string", "description": "\"Connected\" when outlet telemetry is current." }, "outletName": { "type": "string", "description": "Display name configured for the outlet." }, "customRebootTimeEnabled": { "type": "boolean", "description": "True when the outlet uses a custom reboot delay." }, "customRebootTime": { "type": "integer", "format": "int32", "description": "Configured reboot delay in seconds." }, "rebootStatus": { "type": "string", "description": "Current reboot workflow state." }, "currentRms": { "type": "number", "format": "float", "description": "Measured RMS current draw in amps." }, "circuitVoltage": { "type": "number", "format": "float", "description": "Line voltage feeding the outlet." }, "power": { "type": "number", "format": "float", "description": "Real power consumption in watts." }, "referenceValue": { "type": "number", "format": "float", "description": "User-configured reference power value, when set." }, "state": { "type": "string", "description": "\"ON\" when energized, otherwise \"OFF\"." }, "voltageDetection": { "type": "boolean", "description": "True when voltage sensing is enabled for the outlet." }, "relayHealth": { "type": "string", "description": "Health status reported for the outlet relay." }, "pwrOnState": { "type": "string", "description": "Power-on default state (for example \"ON\", \"OFF\", or \"PREV\")." }, "outletIndex": { "type": "integer", "format": "int32", "description": "Outlet index starting at 1." }, "receptacle": { "type": "string", "description": "Outlet receptacle type." }, "bankId": { "type": "integer", "format": "int64", "description": "Numeric identifier for the containing bank." }, "enclosureSerialNumber": { "type": "integer", "format": "int64", "description": "Serial number for the owning device." }, "pduLabeledOutletNum": { "type": "integer", "format": "int32", "description": "Human-visible label printed on the PDU." }, "outlet_id": { "type": "string", "description": "Composite outlet identifier (-)." }, "bank_id": { "type": "integer", "format": "int64", "description": "Bank identifier alias matching bankId." }, "pdu_labeled_outlet_num": { "type": "integer", "format": "int32", "description": "Snake case alias for pduLabeledOutletNum." }, "last_known_name": { "type": "string", "description": "Most recently reported outlet name from the controller." }, "last_known_name_updated_at": { "type": "string", "format": "date-time", "description": "Timestamp when last_known_name was recorded." } } }, "Inlet": { "type": "object", "properties": { "connectionState": { "type": "string" }, "inletCurrentRms": { "type": "number", "format": "float" }, "inletVoltageRms": { "type": "number", "format": "float" }, "inletLineFrequency": { "type": "number", "format": "float" }, "inletPowerFactor": { "type": "number", "format": "float" }, "inletActivePower": { "type": "number", "format": "float" }, "inletApparentPower": { "type": "number", "format": "float" }, "inletEnergyAccumulation": { "type": "number", "format": "float" }, "inletName": { "type": "string" }, "enclosureSerialNumber": { "type": "integer", "format": "int64" }, "inletType": { "type": "string" }, "inletPlug": { "type": "string" }, "inletPhase": { "type": "string" }, "id": { "type": "string" }, "inletLineConfiguration": { "type": "string" } } }, "Bank": { "type": "object", "properties": { "connectionState": { "type": "string" }, "firmwareVersion": { "type": "string" }, "currentRms": { "type": "number", "format": "float" }, "voltageRms": { "type": "number", "format": "float" }, "lineFrequency": { "type": "number", "format": "float" }, "powerFactor": { "type": "number", "format": "float" }, "activePower": { "type": "number", "format": "float" }, "apparentPower": { "type": "number", "format": "float" }, "energyAccumulation": { "type": "number", "format": "float" }, "enclosureSerialNumber": { "type": "integer", "format": "int64" }, "bankName": { "type": "string" }, "inletId": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "hardwareVersion": { "type": "string" }, "outletSwitchingSupported": { "type": "boolean" }, "outletMeteringSupported": { "type": "boolean" }, "bankLines": { "type": "string" }, "hasCircuitBreakerProtection": { "type": "boolean" } } }, "DeviceEvent": { "type": "object", "properties": { "triggered": { "type": "boolean" }, "numTicksBeyond": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "code": { "type": "integer", "format": "int32" }, "params": { "type": "array", "items": { "type": "string" } }, "actions": { "type": "array", "items": { "type": "object" } }, "enclosureSerialNumber": { "type": "integer", "format": "int64" }, "lastChange": { "type": "string", "format": "date-time" }, "connectionState": { "type": "string" } } } } }, "security": [ { "sec0": [] } ], "tags": [ { "name": "Device Inventory", "description": "Inventory, detail, and summary endpoints for SynLink devices." } ], "x-tagGroups": [ { "name": "Devices", "tags": [ "Device Inventory", "Device Live Telemetry", "Device Logs", "Configuration", "Firmware" ] }, { "name": "Power Control", "tags": [ "Outlets", "PDU Outlet Groups", "Inlets", "Banks", "Sensors" ] }, { "name": "Automation", "tags": [ "Events", "Actions" ] }, { "name": "Organization", "tags": [ "Groups" ] } ], "paths": { "/v2/devices/{deviceId}": { "get": { "summary": "Get Device Details", "description": "Retrieve detailed information for a single device, including live outlet, inlet, bank, sensor, and event data when available.", "operationId": "device-detail", "parameters": [ { "name": "deviceId", "in": "path", "description": "Unique enclosure serial number for the device.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeviceDetail" } } }, "examples": { "Result": { "value": { "data": { "deviceName": "SynLink PDU", "connectionState": "Connected", "ipAddress": "192.168.1.166", "numBanks": 1, "numOutlets": 4, "numDryContactRelays": 2, "numInlets": 1, "inletPlug": "IEC-320 C20R", "outletPwrMeasurementsSupported": true, "inletCurrentSupported": false, "outletSwitchingSupported": true, "inletEnergySupported": true, "enclosureSerialNumber": 1509033, "modelNumber": "1001CIE-01-SP1", "inletConfig": "standard", "formFactor": "Compact", "controllerSerialNumber": 1462577936, "controllerFirmwareVersion": "2.5.102", "controllerHardwareVersion": "SP000005 1.17.0", "phase": "Single Phase", "circuitBreakerProtection": false, "lastFwUpdateStatus": "Success-1755287485", "controllerFirmwareVersionUpdatedAt": "2025-08-15T19:56:34.262Z", "lastHeard": "2025-09-24T18:54:55.239Z", "outlets": [ { "connectionState": "Connected", "outletName": "Outlet 1", "customRebootTimeEnabled": false, "customRebootTime": 5, "rebootStatus": "none", "currentRms": 0, "circuitVoltage": 117.5, "power": 0, "referenceValue": 0, "state": "ON", "voltageDetection": true, "relayHealth": "OK", "pwrOnState": "ON", "outletIndex": 1, "receptacle": "NEMA 5-20R", "bankId": 2009571, "enclosureSerialNumber": 1509033, "pduLabeledOutletNum": 1, "outlet_id": "1-2009571", "bank_id": 2009571, "pdu_labeled_outlet_num": 1, "last_known_name": "Outlet 1", "last_known_name_updated_at": "2025-04-08T20:45:06.422Z" } ], "inlets": [ { "connectionState": "Connected", "inletCurrentRms": 0, "inletVoltageRms": 117.4, "inletLineFrequency": 60.138, "inletPowerFactor": 1, "inletActivePower": 0, "inletApparentPower": 0, "inletEnergyAccumulation": 0, "inletName": "IEC-320 C20R Inlet", "enclosureSerialNumber": 1509033, "inletType": "single", "inletPlug": "IEC-320 C20R", "inletPhase": "Single Phase", "id": "I1-1509033", "inletLineConfiguration": "L-N" } ], "banks": [ { "connectionState": "Connected", "firmwareVersion": "010222", "currentRms": 0, "voltageRms": 117.3, "lineFrequency": 60.188, "powerFactor": 0.999969482421875, "activePower": 0, "apparentPower": 0, "energyAccumulation": 0, "enclosureSerialNumber": 1509033, "bankName": "Bank 1", "inletId": "I1-1509033", "id": 2009571, "hardwareVersion": "010100", "outletSwitchingSupported": true, "outletMeteringSupported": true, "bankLines": "L-N", "hasCircuitBreakerProtection": false } ], "sensors": [], "events": [ { "triggered": false, "numTicksBeyond": 0, "id": 1, "name": "Example High Current Event for Bank #1", "enabled": true, "code": 31, "params": [ "2009571", "16", "10" ], "actions": [], "enclosureSerialNumber": 1509033, "lastChange": "2025-09-24T19:03:54.757Z", "connectionState": "Connected" } ] } } } } } } }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "DEVICE_NOT_FOUND" } } } } } } }, "deprecated": false, "tags": [ "Device Inventory" ] } } } } ```