---
updatedAt: 2026-04-29T00:49:36.000Z
agentTools:
  projectIndex: https://synaccess.readme.io/llms.txt
---

# Retrieve A Device

Retrieves the details of a device. If the device is connected, it will show all relevant up to date data.

# 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"
      }
    }
  },
  "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": {
    "/v1/devices/{enclosure_serial_number}": {
      "get": {
        "summary": "Retrieve A Device",
        "description": "Retrieves the details of a device. If the device is connected, it will show all relevant up to date data.",
        "operationId": "retrieve-a-device",
        "parameters": [
          {
            "name": "enclosure_serial_number",
            "in": "path",
            "description": "Serial Number of the PDU to be removed",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"data\": {\n    \"deviceName\": \"Lab PDU #1\",\n    \"connectionState\": \"Connected\",\n    \"numBanks\": 1,\n    \"numOutlets\": 4,\n    \"numDryContactRelays\": 2,\n    \"numInlets\": 1,\n    \"inletPlug\": \"IEC-320 C20R\",\n    \"outletPwrMeasurementsSupported\": true,\n    \"outletSwitchingSupported\": true,\n    \"inletEnergySupported\": true,\n    \"inletCurrentSupported\": false,\n    \"enclosureSerialNumber\": 1502794,\n    \"modelNumber\": \"1005AIE-0E\",\n    \"inletConfig\": \"standard\",\n    \"formFactor\": \"Compact\",\n    \"controllerSerialNumber\": 909127691,\n    \"controllerFirmwareVersion\": \"2.5.50\",\n    \"controllerHardwareVersion\": \"SP000005 1.17.0\",\n    \"phase\": \"Single Phase\",\n    \"circuitBreakerProtection\": false,\n    \"lastFwUpdateStatus\": \"Success-1660173474\",\n    \"outlets\": [\n      {\n        \"connectionState\": \"connected\",\n        \"enclosureSerialNumber\": 1502794,\n        \"outletName\": \"Outlet 1\",\n        \"id\": \"1-2001653\",\n        \"outletIndex\": 1,\n        \"bankId\": 2001653,\n        \"receptacle\": \"NEMA 5-20R\",\n        \"customRebootTimeEnabled\": false,\n        \"customRebootTime\": 5,\n        \"rebootStatus\": \"none\",\n        \"currentRms\": 0.3066897392272949,\n        \"circuitVoltage\": 117.5,\n        \"power\": 36.03604507446289,\n        \"state\": \"ON\",\n        \"voltageDetection\": true,\n        \"relayHealth\": \"OK\",\n        \"pwrOnState\": \"ON\"\n      },\n      {\n        \"connectionState\": \"connected\",\n        \"enclosureSerialNumber\": 1502794,\n        \"outletName\": \"Outlet 2\",\n        \"id\": \"2-2001653\",\n        \"outletIndex\": 2,\n        \"bankId\": 2001653,\n        \"receptacle\": \"NEMA 5-20R\",\n        \"customRebootTimeEnabled\": false,\n        \"customRebootTime\": 5,\n        \"rebootStatus\": \"none\",\n        \"currentRms\": 0.9351103901863098,\n        \"circuitVoltage\": 117.5,\n        \"power\": 109.87547302246094,\n        \"state\": \"ON\",\n        \"voltageDetection\": true,\n        \"relayHealth\": \"OK\",\n        \"pwrOnState\": \"ON\"\n      },\n      {\n        \"connectionState\": \"connected\",\n        \"enclosureSerialNumber\": 1502794,\n        \"outletName\": \"Outlet 3\",\n        \"id\": \"3-2001653\",\n        \"outletIndex\": 3,\n        \"bankId\": 2001653,\n        \"receptacle\": \"NEMA 5-20R\",\n        \"customRebootTimeEnabled\": false,\n        \"customRebootTime\": 5,\n        \"rebootStatus\": \"none\",\n        \"currentRms\": 0.3038674294948578,\n        \"circuitVoltage\": 117.5,\n        \"power\": 35.70442199707031,\n        \"state\": \"ON\",\n        \"voltageDetection\": true,\n        \"relayHealth\": \"OK\",\n        \"pwrOnState\": \"ON\"\n      },\n      {\n        \"connectionState\": \"connected\",\n        \"enclosureSerialNumber\": 1502794,\n        \"outletName\": \"Outlet 4\",\n        \"id\": \"4-2001653\",\n        \"outletIndex\": 4,\n        \"bankId\": 2001653,\n        \"receptacle\": \"NEMA 5-20R\",\n        \"customRebootTimeEnabled\": false,\n        \"customRebootTime\": 5,\n        \"rebootStatus\": \"none\",\n        \"currentRms\": 0,\n        \"circuitVoltage\": 117.5,\n        \"power\": 0,\n        \"state\": \"ON\",\n        \"voltageDetection\": true,\n        \"relayHealth\": \"OK\",\n        \"pwrOnState\": \"ON\"\n      }\n    ],\n    \"inlets\": [\n      {\n        \"connectionState\": \"connected\",\n        \"enclosureSerialNumber\": 1502794,\n        \"inletType\": \"single\",\n        \"inletPlug\": \"IEC-320 C20R\",\n        \"inletPhase\": \"Single Phase\",\n        \"inletName\": \"IEC-320 C20R Inlet\",\n        \"id\": \"I1-1502794\",\n        \"inletLineConfiguration\": \"L-N\",\n        \"inletCurrentRms\": 2.233099937438965,\n        \"inletVoltageRms\": 117.5,\n        \"inletLineFrequency\": 60.1879997253418,\n        \"inletPowerFactor\": 0.9767894148826599,\n        \"inletActivePower\": 256.2900085449219,\n        \"inletApparentPower\": 262.3800048828125,\n        \"inletEnergyAccumulation\": 9.802029609680176\n      }\n    ],\n    \"banks\": [\n      {\n        \"connectionState\": \"connected\",\n        \"enclosureSerialNumber\": 1502794,\n        \"bankName\": \"Bank 1\",\n        \"inletId\": \"I1-1502794\",\n        \"id\": 2001653,\n        \"hardwareVersion\": \"010100\",\n        \"firmwareVersion\": \"010118\",\n        \"outletSwitchingSupported\": true,\n        \"outletMeteringSupported\": true,\n        \"currentRms\": 2.0060999393463135,\n        \"voltageRms\": 117.80000305175781,\n        \"lineFrequency\": 60.1879997253418,\n        \"powerFactor\": 0.974395751953125,\n        \"activePower\": 230.25999450683594,\n        \"apparentPower\": 236.30999755859375,\n        \"energyAccumulation\": 9.80215072631836,\n        \"bankLines\": \"L-N\",\n        \"hasCircuitBreakerProtection\": false\n      }\n    ]\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "deviceName": {
                          "type": "string",
                          "example": "Lab PDU #1"
                        },
                        "connectionState": {
                          "type": "string",
                          "example": "Connected"
                        },
                        "numBanks": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "numOutlets": {
                          "type": "integer",
                          "example": 4,
                          "default": 0
                        },
                        "numDryContactRelays": {
                          "type": "integer",
                          "example": 2,
                          "default": 0
                        },
                        "numInlets": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "inletPlug": {
                          "type": "string",
                          "example": "IEC-320 C20R"
                        },
                        "outletPwrMeasurementsSupported": {
                          "type": "boolean",
                          "example": true,
                          "default": true
                        },
                        "outletSwitchingSupported": {
                          "type": "boolean",
                          "example": true,
                          "default": true
                        },
                        "inletEnergySupported": {
                          "type": "boolean",
                          "example": true,
                          "default": true
                        },
                        "inletCurrentSupported": {
                          "type": "boolean",
                          "example": false,
                          "default": true
                        },
                        "enclosureSerialNumber": {
                          "type": "integer",
                          "example": 1502794,
                          "default": 0
                        },
                        "modelNumber": {
                          "type": "string",
                          "example": "1005AIE-0E"
                        },
                        "inletConfig": {
                          "type": "string",
                          "example": "standard"
                        },
                        "formFactor": {
                          "type": "string",
                          "example": "Compact"
                        },
                        "controllerSerialNumber": {
                          "type": "integer",
                          "example": 909127691,
                          "default": 0
                        },
                        "controllerFirmwareVersion": {
                          "type": "string",
                          "example": "2.5.50"
                        },
                        "controllerHardwareVersion": {
                          "type": "string",
                          "example": "SP000005 1.17.0"
                        },
                        "phase": {
                          "type": "string",
                          "example": "Single Phase"
                        },
                        "circuitBreakerProtection": {
                          "type": "boolean",
                          "example": false,
                          "default": true
                        },
                        "lastFwUpdateStatus": {
                          "type": "string",
                          "example": "Success-1660173474"
                        },
                        "outlets": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "connectionState": {
                                "type": "string",
                                "example": "connected"
                              },
                              "enclosureSerialNumber": {
                                "type": "integer",
                                "example": 1502794,
                                "default": 0
                              },
                              "outletName": {
                                "type": "string",
                                "example": "Outlet 1"
                              },
                              "id": {
                                "type": "string",
                                "example": "1-2001653"
                              },
                              "outletIndex": {
                                "type": "integer",
                                "example": 1,
                                "default": 0
                              },
                              "bankId": {
                                "type": "integer",
                                "example": 2001653,
                                "default": 0
                              },
                              "receptacle": {
                                "type": "string",
                                "example": "NEMA 5-20R"
                              },
                              "customRebootTimeEnabled": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "customRebootTime": {
                                "type": "integer",
                                "example": 5,
                                "default": 0
                              },
                              "rebootStatus": {
                                "type": "string",
                                "example": "none"
                              },
                              "currentRms": {
                                "type": "number",
                                "example": 0.3066897392272949,
                                "default": 0
                              },
                              "circuitVoltage": {
                                "type": "number",
                                "example": 117.5,
                                "default": 0
                              },
                              "power": {
                                "type": "number",
                                "example": 36.03604507446289,
                                "default": 0
                              },
                              "state": {
                                "type": "string",
                                "example": "ON"
                              },
                              "voltageDetection": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              },
                              "relayHealth": {
                                "type": "string",
                                "example": "OK"
                              },
                              "pwrOnState": {
                                "type": "string",
                                "example": "ON"
                              }
                            }
                          }
                        },
                        "inlets": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "connectionState": {
                                "type": "string",
                                "example": "connected"
                              },
                              "enclosureSerialNumber": {
                                "type": "integer",
                                "example": 1502794,
                                "default": 0
                              },
                              "inletType": {
                                "type": "string",
                                "example": "single"
                              },
                              "inletPlug": {
                                "type": "string",
                                "example": "IEC-320 C20R"
                              },
                              "inletPhase": {
                                "type": "string",
                                "example": "Single Phase"
                              },
                              "inletName": {
                                "type": "string",
                                "example": "IEC-320 C20R Inlet"
                              },
                              "id": {
                                "type": "string",
                                "example": "I1-1502794"
                              },
                              "inletLineConfiguration": {
                                "type": "string",
                                "example": "L-N"
                              },
                              "inletCurrentRms": {
                                "type": "number",
                                "example": 2.233099937438965,
                                "default": 0
                              },
                              "inletVoltageRms": {
                                "type": "number",
                                "example": 117.5,
                                "default": 0
                              },
                              "inletLineFrequency": {
                                "type": "number",
                                "example": 60.1879997253418,
                                "default": 0
                              },
                              "inletPowerFactor": {
                                "type": "number",
                                "example": 0.9767894148826599,
                                "default": 0
                              },
                              "inletActivePower": {
                                "type": "number",
                                "example": 256.2900085449219,
                                "default": 0
                              },
                              "inletApparentPower": {
                                "type": "number",
                                "example": 262.3800048828125,
                                "default": 0
                              },
                              "inletEnergyAccumulation": {
                                "type": "number",
                                "example": 9.802029609680176,
                                "default": 0
                              }
                            }
                          }
                        },
                        "banks": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "connectionState": {
                                "type": "string",
                                "example": "connected"
                              },
                              "enclosureSerialNumber": {
                                "type": "integer",
                                "example": 1502794,
                                "default": 0
                              },
                              "bankName": {
                                "type": "string",
                                "example": "Bank 1"
                              },
                              "inletId": {
                                "type": "string",
                                "example": "I1-1502794"
                              },
                              "id": {
                                "type": "integer",
                                "example": 2001653,
                                "default": 0
                              },
                              "hardwareVersion": {
                                "type": "string",
                                "example": "010100"
                              },
                              "firmwareVersion": {
                                "type": "string",
                                "example": "010118"
                              },
                              "outletSwitchingSupported": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              },
                              "outletMeteringSupported": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              },
                              "currentRms": {
                                "type": "number",
                                "example": 2.0060999393463135,
                                "default": 0
                              },
                              "voltageRms": {
                                "type": "number",
                                "example": 117.80000305175781,
                                "default": 0
                              },
                              "lineFrequency": {
                                "type": "number",
                                "example": 60.1879997253418,
                                "default": 0
                              },
                              "powerFactor": {
                                "type": "number",
                                "example": 0.974395751953125,
                                "default": 0
                              },
                              "activePower": {
                                "type": "number",
                                "example": 230.25999450683594,
                                "default": 0
                              },
                              "apparentPower": {
                                "type": "number",
                                "example": 236.30999755859375,
                                "default": 0
                              },
                              "energyAccumulation": {
                                "type": "number",
                                "example": 9.80215072631836,
                                "default": 0
                              },
                              "bankLines": {
                                "type": "string",
                                "example": "L-N"
                              },
                              "hasCircuitBreakerProtection": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "tags": [
          "Device Inventory"
        ]
      }
    }
  }
}
```