---
title: "MyUserVpnConfigList"
method: POST
path: "/users/me/vpn-configs"
tags: ["MyUserVpnConfigList"]
---

# MyUserVpnConfigList

`POST /users/me/vpn-configs`

## Query parameters

- `fields` string[]

## Headers

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

## Request body

- object
  - `hostname` string
  - `type` 'openvpn', required
  - `networkLayer` 'tap' | 'tun', required
  - `transportProtocol` 'udp' | 'tcp' | 'stunnel', required
  - `agent` object, required
    - `publicId` string
  - `addRoutes` boolean, required
  - `rsaPubKey` string

## Response `201`

Success response

- object
  - `status` string, required
  - `type` string, required
  - `data` object, required
    - `openvpnConfig` string
    - `agent` object
      - `publicId` string
      - `name` string, nullable
      - `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
      - `location` object, nullable
        - `name` string
        - `latitude` string
        - `longitude` string
      - `geoLocation` object, nullable
        - `latitude` string
        - `longitude` string
        - `country` string
        - `city` string
      - `timeZone` string, nullable
      - `custom` object
      - `description` string, nullable
      - `useStunnel` boolean
      - `preferLocationOverGeoip` boolean
      - `reRegistration` boolean
      - `replaceRegistration` boolean
      - `replaceMacAddress` string, nullable
      - `fixedVpnAddress` string, nullable
      - `macAddress` string
      - `serialNumber` string
      - `pullCodeGeneratedOn` string, date-time, nullable
      - `controlKeyGeneratedOn` string, date-time, nullable
      - `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
      - `networkValues` object[]
        - `interface` string
        - `name` string
        - `value` string[]
      - `networkReportedOn` string, date-time, nullable
      - `activeStatus` 'active' | 'inactive'
      - `activationLicence` object, nullable
        - `publicId` string
        - `type` object
          - `publicId` string
          - `usageType` 'advanced-user-management' | 'agent-registration-profile' | 'agent-templates' | 'alarming' | 'api-integrations' | 'app-engine-level-1' | 'app-engine-level-2' | 'app-engine-level-3' | 'asset-management' | 'card-view' | 'connection-monitoring' | 'controlled-devices' | 'custom-branding' | 'custom-domain' | 'custom-fields' | 'custom-legal' | 'custom-legal-legacy' | 'custom-sso' | 'edge-app-management' | 'ixagent' | 'landing-page' | 'live-data' | 'logging' | 'm2m-cloud-cluster' | 'main-pages' | 'mobile-app' | 'mqtt-device' | 'object-storage' | 'premium-branding' | 'rdp' | 'remote-access' | 'reporting' | 'request-access' | 'rtsp' | 'scim' | 'session-recording' | 'sla' | 'ssh' | 'subgroups' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage'
          - `companyLimit` integer, nullable
          - `scope` 'agent' | 'company'
        - `serialNumber` string
        - `expiresOn` string, date-time, nullable
        - `activated` boolean
        - `trial` boolean
        - `value` string, nullable
        - `locked` boolean, nullable
        - `maxRetentionPolicy` string, nullable
        - `bundle` object, nullable
          - `publicId` string
          - `name` string
      - `pendingRegistration` boolean
      - `card` object, nullable
        - `publicId` string
      - `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
      - `webAccessConnections` object[]
        - `user` object
          - `publicId` string
          - `name` string
        - `agentServer` object
          - `publicId` string
          - `name` string
          - `type` 'http' | 'rdp' | 'rtsp' | 'ssh' | 'vnc' | 'websocket'
      - `vpnChangedOn` string, date-time, nullable
      - `mdrServer` object, nullable
        - `publicId` string
        - `name` string
      - `mqttChangedOn` string, date-time, nullable
      - `loggingMdrServer` object, nullable
        - `publicId` string
        - `name` string
      - `loggingMqttChangedOn` string, date-time, nullable
      - `lsiServer` object, nullable
        - `publicId` string
        - `name` string
      - `company` object
        - `publicId` string
        - `name` string
      - `controlledBy` object, nullable
        - `publicId` string
        - `name` 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
      - `memberships` object[]
        - `publicId` string
        - `agent` object
          - `publicId` string
        - `group` object
          - `publicId` string
      - `rateLimiting` object
        - `configMqttCommandLimit` 'soft' | 'hard' | 'lock', nullable
        - `configMqttCommandCounter` integer, nullable
        - `configMqttCommandLastHit` string, date-time, nullable
        - `configMqttDataLimit` 'soft' | 'hard' | 'lock', nullable
        - `configMqttDataCounter` integer, nullable
        - `configMqttDataLastHit` string, date-time, nullable
        - `configOpenvpnLimit` 'soft' | 'hard' | 'lock', nullable
        - `configOpenvpnCounter` integer, nullable
        - `configOpenvpnLastHit` string, date-time, nullable
      - `vpnProtocol` 'udp' | 'tcp'
      - `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
      - `demoDevice` object, nullable
        - `publicId` string
        - `expiresOn` string, date-time
        - `agentType` 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
              - …
            - `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
        - `dmvServer` object
          - `publicId` string
          - `name` string
      - `connectedUsers` object[]
        - `publicId` string
        - `name` string
      - `loggingApp` object
        - `licence` object, nullable
          - `publicId` string
          - `type` object
            - `publicId` string
            - `usageType` 'advanced-user-management' | 'agent-registration-profile' | 'agent-templates' | 'alarming' | 'api-integrations' | 'app-engine-level-1' | 'app-engine-level-2' | 'app-engine-level-3' | 'asset-management' | 'card-view' | 'connection-monitoring' | 'controlled-devices' | 'custom-branding' | 'custom-domain' | 'custom-fields' | 'custom-legal' | 'custom-legal-legacy' | 'custom-sso' | 'edge-app-management' | 'ixagent' | 'landing-page' | 'live-data' | 'logging' | 'm2m-cloud-cluster' | 'main-pages' | 'mobile-app' | 'mqtt-device' | 'object-storage' | 'premium-branding' | 'rdp' | 'remote-access' | 'reporting' | 'request-access' | 'rtsp' | 'scim' | 'session-recording' | 'sla' | 'ssh' | 'subgroups' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage'
            - `companyLimit` integer, nullable
            - `scope` 'agent' | 'company'
          - `serialNumber` string
          - `expiresOn` string, date-time, nullable
          - `activated` boolean
          - `trial` boolean
          - `value` string, nullable
          - `locked` boolean, nullable
          - `maxRetentionPolicy` string, nullable
          - `agent` object, nullable
            - `publicId` string
            - `name` string, nullable
            - `deviceId` string
            - `type` object
              - …
            - `location` object
              - …
            - `geoLocation` object
              - …
            - `custom` object
          - `hasAgent` boolean
          - `agentType` object, nullable
            - `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
            - `name` string
            - `offlineConfiguration` boolean
            - `openvpnConfigMultiUse` boolean
            - `purchasePrice` object
            - `router` boolean
            - `stunnelSupport` boolean
            - `wanPortForwardings` boolean
            - `custom` object
            - `hasSecondWanPort` boolean
          - `bundle` object, nullable
            - `publicId` string
            - `name` string
        - `enabled` boolean
      - `valuesPerHour` integer
      - `alarmingApp` object
        - `licence` object, nullable
          - `publicId` string
          - `type` object
            - `publicId` string
            - `usageType` 'advanced-user-management' | 'agent-registration-profile' | 'agent-templates' | 'alarming' | 'api-integrations' | 'app-engine-level-1' | 'app-engine-level-2' | 'app-engine-level-3' | 'asset-management' | 'card-view' | 'connection-monitoring' | 'controlled-devices' | 'custom-branding' | 'custom-domain' | 'custom-fields' | 'custom-legal' | 'custom-legal-legacy' | 'custom-sso' | 'edge-app-management' | 'ixagent' | 'landing-page' | 'live-data' | 'logging' | 'm2m-cloud-cluster' | 'main-pages' | 'mobile-app' | 'mqtt-device' | 'object-storage' | 'premium-branding' | 'rdp' | 'remote-access' | 'reporting' | 'request-access' | 'rtsp' | 'scim' | 'session-recording' | 'sla' | 'ssh' | 'subgroups' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage'
            - `companyLimit` integer, nullable
            - `scope` 'agent' | 'company'
          - `serialNumber` string
          - `expiresOn` string, date-time, nullable
          - `activated` boolean
          - `trial` boolean
          - `value` string, nullable
          - `locked` boolean, nullable
          - `maxRetentionPolicy` string, nullable
          - `agent` object, nullable
            - `publicId` string
            - `name` string, nullable
            - `deviceId` string
            - `type` object
              - …
            - `location` object
              - …
            - `geoLocation` object
              - …
            - `custom` object
          - `hasAgent` boolean
          - `agentType` object, nullable
            - `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
            - `name` string
            - `offlineConfiguration` boolean
            - `openvpnConfigMultiUse` boolean
            - `purchasePrice` object
            - `router` boolean
            - `stunnelSupport` boolean
            - `wanPortForwardings` boolean
            - `custom` object
            - `hasSecondWanPort` boolean
          - `bundle` object, nullable
            - `publicId` string
            - `name` string
        - `enabled` boolean
      - `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
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - `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
      - `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
      - `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
      - `scheduledAccessRequests` object[]
        - `publicId` string
        - `agent` object
          - `publicId` string
        - `user` object
          - `publicId` string
          - `name` string
        - `approver` object, nullable
          - `publicId` string
          - `name` string
        - `approverCompany` object, nullable
          - `publicId` string
        - `vpn` boolean
        - `servers` object[]
          - `publicId` string
          - `name` string
          - `type` 'http' | 'rdp' | 'rtsp' | 'ssh' | 'vnc' | 'websocket'
        - `start` string, date-time
        - `end` string, date-time
        - `status` 'approved' | 'pending' | 'rejected' | 'revoked'
        - `reason` string
        - `createdOn` string, date-time
        - `updatedOn` string, date-time, nullable
        - `allowedApprovers` object[]
          - `publicId` string
          - `name` string
        - `reviewExpiresOn` string, date-time, nullable
      - `assets` object[]
        - `publicId` string
      - `registrationProfile` object, nullable
        - `publicId` string
        - `name` string, nullable
        - `agentActivationName` string, nullable
      - `vpnLocked` boolean
      - `webAccessLocked` boolean
      - `configPushLocked` boolean
      - `rebootLocked` boolean
      - `firmwareUpdateLocked` boolean
      - `appliedTemplateVersion` object, nullable
        - `publicId` string
        - `createdOn` string, date-time
        - `createdBy` object
          - `publicId` string
          - `name` string
        - `company` object
          - `publicId` string
        - `description` string, nullable
        - `agentTemplate` object
          - `publicId` string
        - `number` string
    - `company` object
      - `publicId` string
      - `name` string
      - `custom` object
      - `branding` object, nullable
        - `publicId` string
        - `name` string, nullable
        - `fqdn` string, nullable
        - `theme` object, nullable
          - `primaryColor` string
          - `primaryTextColor` string
          - `accentColor` string, nullable
          - `accentTextColor` string, nullable
          - `headerColor` string, nullable
          - `headerLineColor` string, nullable
          - `menuColor` string, nullable
          - `menuTextColor` string, nullable
          - `pageColor` string, nullable
          - `pageTextColor` string, nullable
          - `cardColor` string, nullable
          - `cardTextColor` string, nullable
          - `logoHasBackgroundColor` boolean
          - `logoOnHeaderColorSpec` string, nullable
        - `appleTouchIcon` string, nullable
        - `favicon` string, nullable
        - `logo` string, nullable
        - `logoDark` string, nullable
        - `appleAppStoreLink` string, nullable
        - `googlePlayStoreLink` string, nullable
        - `landingPageComponentTemplate` object, nullable
          - `publicId` string
          - `company` object, nullable
            - `publicId` string
          - `name` string
          - `description` string, nullable
          - `version` string, nullable
          - `author` string, nullable
          - `licence` string, nullable
          - `url` string, nullable
          - `sheetSettings` object, nullable
            - `minCols` integer
            - `defaultCols` integer, nullable
            - `maxCols` integer, nullable
            - `minRows` integer
            - `defaultRows` integer, nullable
            - `maxRows` integer, nullable
          - `cardSettings` object, nullable
            - `minHeight` integer
            - `defaultHeight` integer, nullable
            - `maxHeight` integer, nullable
          - `inputs` string, nullable
          - `draft` object, nullable
            - `publicId` string
          - `published` object, nullable
            - `publicId` string
          - `category` object
            - `publicId` string
            - `name` string
            - `order` integer
          - `configuredVersion` object, nullable
            - `publicId` string
            - `number` string
            - `mainPath` string
          - `backendComponent` object, nullable
            - `publicId` string
          - `static` boolean
          - `intent` string[]
          - `private` boolean
        - `custom` object
      - `customTermsOfUse` 'sector' | 'company' | 'disabled'
      - `customPrivacyStatement` 'sector' | 'company' | 'disabled'
      - `latestTermsOfUse` object
        - `publicId` string
        - `company` object, nullable
          - `publicId` string
        - `latest` boolean, nullable
        - `version` string, nullable
        - `publishedOn` string, date-time, nullable
        - `downloadUrl` string, nullable
        - `type` 'termsofuse' | 'privacystatement'
        - `languages` object[]
          - `publicId` string
          - `languageCode` string
          - `body` string
          - `updateSummary` string, nullable
          - `policy` object
            - `publicId` string
      - `latestPrivacyStatement` object
        - `publicId` string
        - `company` object, nullable
          - `publicId` string
        - `latest` boolean, nullable
        - `version` string, nullable
        - `publishedOn` string, date-time, nullable
        - `downloadUrl` string, nullable
        - `type` 'termsofuse' | 'privacystatement'
        - `languages` object[]
          - `publicId` string
          - `languageCode` string
          - `body` string
          - `updateSummary` string, nullable
          - `policy` 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)