---
title: "ControlledDevice"
method: GET
path: "/controlled-devices/{publicId}"
tags: ["ControlledDevice"]
---

# ControlledDevice

`GET /controlled-devices/{publicId}`

## Path parameters

- `publicId` string, required

## Query parameters

- `fields` string[]
- `filters` string[]

## Headers

- `Api-Version` 2, required
- `Api-Application` string, required
- `Api-Company` string, required
- `Api-Branding` string

## Response `200`

Success response

- object
  - `status` string, required
  - `type` string, required
  - `data` object, required
    - `publicId` string
    - `name` string
    - `agent` object
      - `publicId` string
      - `deviceId` string
      - `type` object
        - `publicId` string
        - `additionalSubnets` boolean
        - `allowDataPublishing` boolean
        - `allowDemoDevice` boolean
        - `allowTemplating` boolean
        - `allowReboot` boolean
        - `configPush` boolean
        - `configFileFormat` integer
        - `customServers` boolean
        - `deviceIdFormat` string
        - `httpProxyPort` integer, nullable
        - `latestFirmwareFile` object
          - `publicId` string
          - `name` string
          - `description` string
          - `code` string
          - `notes` string
          - `agentType` object
            - `publicId` string
          - `type` 'firmware'
          - `latest` boolean
          - `custom` object
        - `name` string
        - `offlineConfiguration` boolean
        - `openvpnConfigMultiUse` boolean
        - `purchasePrice` object
          - `gratis` boolean
        - `router` boolean
        - `stunnelSupport` boolean
        - `wanPortForwardings` boolean
        - `custom` object
        - `hasSecondWanPort` boolean
      - `config` object
        - `publicId` string
        - `agent` object
          - `publicId` string
        - `configFileServer` string, nullable
        - `configPushedOn` string, date-time, nullable
        - `configFileReported` string, nullable
        - `configFileReportedWlanKeyEnabled` boolean
        - `configFileReportedCellularPasswordEnabled` boolean
        - `configReportedOn` string, date-time, nullable
        - `differentConfigs` boolean
        - `differentWanConfigs` boolean
        - `stewardConfigFileServer` string, nullable
        - `stewardConfigFileReported` string, nullable
        - `stewardConfigReportedOn` string, date-time, nullable
        - `differentStewardConfigs` boolean
        - `routerLan` object
          - `agent` object
            - `publicId` string
          - `ipAddress` string
          - `netMask` string
          - `network` string
          - `dhcpServerEnabled` boolean
          - `dhcpServerRangeFrom` string, nullable
          - `dhcpServerRangeTo` string, nullable
          - `gatewayLessRouting` boolean
          - `forwardLanWan` 'neither' | 'public' | 'private' | 'both'
          - `forwardLanWan2` 'neither' | 'public' | 'private' | 'both'
          - `wlanEnable` boolean, nullable
          - `wlanSsid` string, nullable
          - `wlanKey` string, nullable
          - `wlanChannel` integer, nullable
          - `bacnetBbmd` string[]
          - `udpBroadcastRelayPort` integer[]
        - `routerVpn` object
          - `agent` object
            - `publicId` string
          - `sourceNatEnabled` boolean
        - `routerWan` object
          - `agent` object
            - `publicId` string
          - `multiwanPolicy` 'eth_cell_wifi' | 'cell_eth_wifi' | 'eth_wifi_cell' | 'wifi_eth_cell' | 'cell_wifi_eth' | 'wifi_cell_eth', nullable
          - `ipUseDhcp` boolean, nullable
          - `ipAddress` string, nullable
          - `ipGateway` string, nullable
          - `ipNetMask` string, nullable
          - `dnsServers` string[]
          - `dnsRebindProtectionEnabled` boolean, nullable
          - `cellularApn` string, nullable
          - `cellularPincode` string, nullable
          - `cellularMtu` integer, nullable
          - `digitalInputMode` 'disable_vpn_high' | 'disable_vpn_low' | 'disable_wan_high' | 'disable_wan_low', nullable
          - `wanTrackInterval` integer, nullable
          - `wanTrackIps` string[]
          - `wlanTrackInterval` integer, nullable
          - `wlanTrackIps` string[]
          - `cellularTrackInterval` integer, nullable
          - `cellularTrackIps` string[]
          - `httpProxyAddress` string, nullable
          - `httpProxyPort` integer, nullable
          - `httpProxyAuthentication` 'none' | 'basic' | 'ntlm', nullable
          - `httpProxyUsername` string, nullable
          - `httpProxyIsSocks5` boolean, nullable
          - `wlanSsid` string, nullable
          - `wlanIpUseDhcp` boolean, nullable
          - `wlanIpAddress` string, nullable
          - `wlanIpGateway` string, nullable
          - `wlanIpNetMask` string, nullable
          - `wlanDnsServers` string[]
          - `cellularUsername` string, nullable
        - `routerDisplay` object
          - `agent` object
            - `publicId` string
          - `lockEnabled` boolean
          - `lockCode` string, nullable
        - `routerAdditionalSubnets` object[]
          - `publicId` string
          - `networkAddress` string
          - `networkMask` string
          - `gatewayAddress` string
          - `agent` object
            - `publicId` string
        - `routerPortForwards` object[]
          - `publicId` string
          - `interface` 'VPN' | 'WAN' | 'WAN2'
          - `targetIpAddress` string
          - `targetPort` integer
          - `externalPort` integer
          - `agent` object
            - `publicId` string
        - `routerNtpServers` object[]
          - `publicId` string
          - `agent` object
            - `publicId` string
          - `server` string
      - `macAddress` string
      - `serialNumber` string
      - `company` object
        - `publicId` string
        - `name` string
      - `activeStatus` 'active' | 'inactive'
      - `activeVpnSession` object, nullable
        - `rscServer` object
          - `publicId` string
          - `name` string
          - `vpnRange` string
          - `supportedLayers` string[]
          - `location` object
            - `name` string
            - `latitude` string
            - `longitude` string
        - `startedOn` string, date-time
        - `sessionName` string
        - `vpnAddress` string, nullable
        - `closed` boolean
      - `vpnChangedOn` string, date-time, nullable
      - `mqttChangedOn` string, date-time, nullable
      - `mdrServer` object, nullable
        - `publicId` string
        - `name` string
      - `lastSeenAgentUserAgent` object, nullable
        - `publicId` string
        - `value` string, nullable
        - `configName` string, nullable
        - `configVersion` string, nullable
        - `hardware` string, nullable
        - `hardwareCode` string, nullable
        - `hardwareVersion` string, nullable
        - `firmwareVersion` string, nullable
        - `osName` string, nullable
        - `osVersion` string, nullable
        - `appName` string, nullable
        - `appVersion` string, nullable
        - `packageName` string, nullable
        - `packageVersion` string, nullable
        - `libixagentVersion` string, nullable
        - `libixloggerVersion` string, nullable
        - `logOnTrigger` boolean
        - `alarming` boolean
        - `dataMonitoring` boolean
        - `wifi` boolean
        - `remoteFirmwareUpgrade` boolean
        - `staticMapping` boolean
        - `stewardConfigPush` boolean
        - `wanInterfaceEth0` boolean
        - `wanInterfaceWifi0` boolean
        - `wanInterfaceCell0` '3G' | '4G' | 'neither'
        - `multiWan` boolean
        - `openvpnVersion` string, nullable
        - `openvpnOccEnabled` boolean
        - `openvpnOpensslVersion` string, nullable
      - `vpnLocked` boolean
      - `webAccessLocked` boolean
      - `configPushLocked` boolean
      - `rebootLocked` boolean
      - `firmwareUpdateLocked` boolean
    - `memberships` object[]
      - `publicId` string
      - `controlledDevice` object
        - `publicId` string
      - `group` object
        - `publicId` string

## Other responses

- `4XX` — 4XX error response

---

[API](https://skmtc.net/ixon/apis/ixon-api.md) · [All operations](https://skmtc.net/ixon/apis/ixon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ixon/ixon-api/versions/7875dc33d41f/schema)