---
title: "AgentTemplateList"
method: GET
path: "/agent-templates"
tags: ["AgentTemplateList"]
---

# AgentTemplateList

`GET /agent-templates`

## 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. Data could be an object instead of a list when one value is returned

- object
  - `status` string, required
  - `type` string, required
  - `moreAfter` string, nullable
  - `data` object[], required
    - `publicId` string
    - `company` object
      - `publicId` string
    - `group` object
      - `publicId` string
    - `name` string, nullable
    - `description` string, nullable
    - `useStunnel` 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
    - `card` object
      - `publicId` string
    - `vpnAudience` object
      - `publicId` string
      - `name` string
      - `description` string, nullable
      - `custom` object
      - `default` boolean
      - `type` 'alarm' | 'page' | 'service', nullable
    - `vpnRequireAccessApproval` boolean
    - `vpnAccessRules` object[]
      - `publicId` string
      - `agent` object
        - `publicId` string
      - `audience` object
        - `publicId` string
      - `ipAddress` string
      - `netMask` string
    - `vpnVisibleInMobileApp` boolean
    - `vpnVisibleOnWeb` boolean
    - `dataAudience` object, nullable
      - `publicId` string
      - `name` string
      - `description` string, nullable
      - `custom` object
      - `default` boolean
      - `type` 'alarm' | 'page' | 'service', nullable
    - `lanWanAccessRules` object[]
      - `publicId` string
      - `agent` object
        - `publicId` string
      - `sourceIpAddress` string, nullable
      - `sourceMacAddress` string, nullable
      - `destinationPort` integer, nullable
      - `destinationIpAddress` string, nullable
      - `protocol` 'all' | 'tcp' | 'udp' | 'icmp' | 'ah' | 'ax.25' | 'dccp' | 'ddp' | 'egp' | 'eigrp' | 'encap' | 'esp' | 'etherip' | 'fc' | 'ggp' | 'gre' | 'hmp' | 'idpr-cmtp' | 'idrp' | 'igmp' | 'igp' | 'ipcomp' | 'ipencap' | 'ipip' | 'ipv6' | 'ipv6-frag' | 'ipv6-icmp' | 'ipv6-nonxt' | 'ipv6-opts' | 'ipv6-route' | 'isis' | 'iso-tp4' | 'l2tp' | 'ospf' | 'pim' | 'pup' | 'rdp' | 'rspf' | 'rsvp' | 'sctp' | 'skip' | 'st' | 'vmtp' | 'vrrp' | 'xns-idp' | 'xtp'
      - `description` string, nullable
    - `oneToOneNatRules` object[]
      - `publicId` string
      - `agent` object
        - `publicId` string
      - `type` 'wan' | 'wlan' | 'vpn'
      - `virtualIpAddress` string
      - `destinationIpAddress` string
      - `protocol` string
      - `port` integer, nullable
      - `sourceIpAddress` string, nullable
      - `description` string, nullable
    - `devices` object[]
      - `publicId` string
      - `name` string, nullable
      - `ipAddress` string, nullable
      - `macAddress` string, nullable
      - `customAddress` string, nullable
      - `agent` object
        - `publicId` string
      - `dataSources` object[]
        - `agent` object
          - `publicId` string
        - `continueLoggingOnError` boolean, nullable
        - `device` object
          - `publicId` string
        - `gracePeriod` integer, nullable
        - `publicId` string
        - `name` string
        - `slug` string
        - `disabled` boolean
        - `protocol` union
          - object
            - `publicId` 'custom', required
            - `password` string, required
          - object
            - `publicId` 'modbus', required
            - `slave` integer, nullable
            - `format` 'ABCD' | 'BADC' | 'CDAB' | 'DCBA', nullable
            - `readMode` 'single_value' | 'consecutive_values' | 'gapped_values', nullable
          - object
            - `publicId` 'siemens-step7', required
            - `pdu` integer, nullable
            - `rack` integer, nullable
            - `slot` integer, nullable
          - object
            - `publicId` 'opc-ua', required
            - `authenticationType` 'anonymous' | 'username' | 'certificate', required
            - `username` string, nullable
            - `password` string, nullable
            - `securityMode` 'sign' | 'signandencrypt', nullable
            - `securityPolicy` 'basic256sha256' | 'aes128_sha256_rsaoaep' | 'aes256_sha256_rsapss', nullable
          - object
            - `publicId` 'ethernet-ip', required
            - `cpu` 'compactlogix' | 'micro800' | 'micrologix' | 'micrologix800' | 'omron', required
            - `rack` integer, nullable
            - `slot` integer, nullable
          - object
            - `publicId` 'host', required
          - object
            - `publicId` 'bacnet-ip', required
            - `deviceId` integer, nullable
          - object
            - `publicId` 'mc-protocol', required
            - `cpu` 'FX5U' | 'IQR' | 'L' | 'Q' | 'QNUCPU', nullable
            - `protocol` 'TCP' | 'UDP', nullable
            - `networkNo` integer, nullable
            - `pcNo` string, nullable
            - `requestDestIoNr` string, nullable
            - `requestDestModuleStatNr` integer, nullable
            - `authenticationType` 'none' | 'password', nullable
            - `password` string, nullable
            - `reconnectDelay` integer, nullable
            - `maxBlocks` integer, nullable
            - `maxPoints` integer, nullable
        - `port` integer, nullable
        - `pullDelay` integer, nullable
        - `valuesPerHour` integer
        - `mqttTopic` string, nullable
        - `mqttBrokerClient` object, nullable
          - `publicId` string
      - `lanNetwork` object, nullable
        - `publicId` string
    - `servers` object[]
      - `publicId` string
      - `type` 'http' | 'rdp' | 'rtsp' | 'ssh' | 'vnc' | 'websocket'
      - `name` string
      - `port` integer
      - `username` string, nullable
      - `password` string, nullable
      - `hasPassword` boolean
      - `authDomain` string, nullable
      - `landingPage` string
      - `connectionQuality` 'low' | 'normal' | 'high', nullable
      - `readOnly` boolean, nullable
      - `vncRightClickOnTouchHold` boolean
      - `vncEncoding` 'copyrect' | 'corre' | 'hextile' | 'raw' | 'rre' | 'tight' | 'ultra' | 'ultrazip' | 'zlib' | 'zlibhex' | 'zrle' | 'zywrle', nullable
      - `useSsl` boolean
      - `visibleInMobileApp` boolean
      - `visibleOnWeb` boolean
      - `httpAuthenticationType` 'ntlm' | 'basic' | 'digest', nullable
      - `flags` string[]
      - `recordSessions` boolean, nullable
      - `audience` object
        - `publicId` string
      - `requireAccessApproval` boolean
      - `custom` object
      - `agent` object
        - `publicId` string
      - `device` object
        - `publicId` string
      - `serviceGroup` string, nullable
      - `template` object, nullable
        - `publicId` string
        - `type` 'http' | 'rdp' | 'rtsp' | 'ssh' | 'vnc' | 'websocket'
        - `name` string
        - `port` integer
        - `username` string, nullable
        - `password` string, nullable
        - `hasPassword` boolean
        - `authDomain` string, nullable
        - `landingPage` string
        - `connectionQuality` 'low' | 'normal' | 'high', nullable
        - `readOnly` boolean, nullable
        - `vncRightClickOnTouchHold` boolean
        - `vncEncoding` 'copyrect' | 'corre' | 'hextile' | 'raw' | 'rre' | 'tight' | 'ultra' | 'ultrazip' | 'zlib' | 'zlibhex' | 'zrle' | 'zywrle', nullable
        - `useSsl` boolean
        - `visibleInMobileApp` boolean
        - `visibleOnWeb` boolean
        - `httpAuthenticationType` 'ntlm' | 'basic' | 'digest', nullable
        - `flags` string[]
        - `recordSessions` boolean, nullable
        - `audience` object
          - `publicId` string
        - `requireAccessApproval` boolean
        - `custom` object
    - `pageLinks` object[]
      - `publicId` string
      - `agent` object, nullable
        - `publicId` string
      - `asset` object, nullable
        - `publicId` string
      - `menuItem` object, nullable
        - `publicId` string
      - `page` object
        - `publicId` string
      - `audience` object, nullable
        - `publicId` string
        - `name` string
        - `description` string, nullable
        - `custom` object
        - `default` boolean
        - `type` 'alarm' | 'page' | 'service', nullable
      - `group` object, nullable
        - `publicId` string
        - `agent` object, nullable
          - `publicId` string
        - `asset` object, nullable
          - `publicId` string
        - `menuItem` object, nullable
          - `publicId` string
        - `name` string
      - `order` integer
      - `custom` object
    - `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
    - `dataSources` object[]
      - `agent` object
        - `publicId` string
      - `continueLoggingOnError` boolean, nullable
      - `device` object
        - `publicId` string
      - `gracePeriod` integer, nullable
      - `publicId` string
      - `name` string
      - `slug` string
      - `disabled` boolean
      - `protocol` union
        - object
          - `publicId` 'custom', required
          - `password` string, required
        - object
          - `publicId` 'modbus', required
          - `slave` integer, nullable
          - `format` 'ABCD' | 'BADC' | 'CDAB' | 'DCBA', nullable
          - `readMode` 'single_value' | 'consecutive_values' | 'gapped_values', nullable
        - object
          - `publicId` 'siemens-step7', required
          - `pdu` integer, nullable
          - `rack` integer, nullable
          - `slot` integer, nullable
        - object
          - `publicId` 'opc-ua', required
          - `authenticationType` 'anonymous' | 'username' | 'certificate', required
          - `username` string, nullable
          - `password` string, nullable
          - `securityMode` 'sign' | 'signandencrypt', nullable
          - `securityPolicy` 'basic256sha256' | 'aes128_sha256_rsaoaep' | 'aes256_sha256_rsapss', nullable
        - object
          - `publicId` 'ethernet-ip', required
          - `cpu` 'compactlogix' | 'micro800' | 'micrologix' | 'micrologix800' | 'omron', required
          - `rack` integer, nullable
          - `slot` integer, nullable
        - object
          - `publicId` 'host', required
        - object
          - `publicId` 'bacnet-ip', required
          - `deviceId` integer, nullable
        - object
          - `publicId` 'mc-protocol', required
          - `cpu` 'FX5U' | 'IQR' | 'L' | 'Q' | 'QNUCPU', nullable
          - `protocol` 'TCP' | 'UDP', nullable
          - `networkNo` integer, nullable
          - `pcNo` string, nullable
          - `requestDestIoNr` string, nullable
          - `requestDestModuleStatNr` integer, nullable
          - `authenticationType` 'none' | 'password', nullable
          - `password` string, nullable
          - `reconnectDelay` integer, nullable
          - `maxBlocks` integer, nullable
          - `maxPoints` integer, nullable
      - `port` integer, nullable
      - `pullDelay` integer, nullable
      - `valuesPerHour` integer
      - `mqttTopic` string, nullable
      - `mqttBrokerClient` object, nullable
        - `publicId` string
    - `vpnProtocol` 'udp' | 'tcp'
    - `updatedOn` string, date-time, nullable
    - `updatedBy` object, nullable
      - `publicId` string
      - `name` string
    - `latestVersion` object, nullable
      - `publicId` string
      - `createdOn` string, date-time
      - `number` string
    - `custom` object

## 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)