IXON Agent API
The Agent API from IXON — 1 operation(s) for agent.
OpenAPI Specification
openapi: 3.0.2
info:
contact:
name: IXON B.V.
url: https://www.ixon.cloud/
email: support@ixon.cloud
description: API for the IXON Cloud Platform
license:
name: All Rights Reserved
url: https://www.ixon.cloud/
title: IXON AccessRecoverList Agent API
version: 0.1.294
servers:
- description: IXON Cloud platform server
url: https://portal.ixon.cloud:443/api/
tags:
- name: Agent
paths:
/agents/{publicId}:
get:
tags:
- Agent
summary: Agent
responses:
'200':
description: Success response
content:
application/json:
schema:
type: object
required:
- status
- type
- data
properties:
status:
type: string
default: success
nullable: false
type:
type: string
nullable: false
data:
nullable: false
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 0
nullable: true
type: string
deviceId:
maxLength: 128
minLength: 1
nullable: false
type: string
type:
nullable: false
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
additionalSubnets:
nullable: false
type: boolean
allowDataPublishing:
nullable: false
type: boolean
allowDemoDevice:
nullable: false
type: boolean
allowTemplating:
nullable: false
type: boolean
allowReboot:
nullable: false
type: boolean
configPush:
nullable: false
type: boolean
configFileFormat:
maximum: 4294967295
nullable: false
type: integer
format: int32
customServers:
nullable: false
type: boolean
deviceIdFormat:
maxLength: 255
minLength: 1
nullable: false
type: string
httpProxyPort:
maximum: 65535
nullable: true
type: integer
format: int32
latestFirmwareFile:
nullable: false
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
description:
maxLength: 65535
minLength: 0
nullable: false
type: string
code:
maxLength: 255
minLength: 1
nullable: false
type: string
notes:
maxLength: 65535
minLength: 0
nullable: false
type: string
agentType:
nullable: false
type: object
properties:
publicId:
nullable: false
type: string
type:
enum:
- firmware
nullable: false
type: string
latest:
nullable: false
type: boolean
custom:
nullable: false
type: object
name:
maxLength: 255
minLength: 1
nullable: false
type: string
offlineConfiguration:
nullable: false
type: boolean
openvpnConfigMultiUse:
nullable: false
type: boolean
purchasePrice:
nullable: false
type: object
properties:
gratis:
nullable: false
type: boolean
router:
nullable: false
type: boolean
stunnelSupport:
nullable: false
type: boolean
wanPortForwardings:
nullable: false
type: boolean
custom:
nullable: false
type: object
hasSecondWanPort:
nullable: false
type: boolean
location:
nullable: true
type: object
properties:
name:
maxLength: 255
minLength: 1
nullable: false
type: string
latitude:
nullable: false
type: string
longitude:
nullable: false
type: string
geoLocation:
nullable: true
type: object
properties:
latitude:
nullable: false
type: string
longitude:
nullable: false
type: string
country:
maxLength: 255
minLength: 1
nullable: false
type: string
city:
maxLength: 255
minLength: 1
nullable: false
type: string
timeZone:
maxLength: 255
minLength: 1
nullable: true
type: string
custom:
nullable: false
type: object
description:
maxLength: 65535
minLength: 0
nullable: true
type: string
useStunnel:
nullable: false
type: boolean
preferLocationOverGeoip:
nullable: false
type: boolean
reRegistration:
nullable: false
type: boolean
replaceRegistration:
nullable: false
type: boolean
replaceMacAddress:
maxLength: 17
minLength: 0
nullable: true
pattern: '[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}'
type: string
fixedVpnAddress:
maxLength: 255
minLength: 0
nullable: true
type: string
macAddress:
maxLength: 17
minLength: 1
nullable: false
type: string
serialNumber:
maxLength: 128
minLength: 1
nullable: false
type: string
pullCodeGeneratedOn:
nullable: true
type: string
format: date-time
controlKeyGeneratedOn:
nullable: true
type: string
format: date-time
lastSeenAgentUserAgent:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
value:
maxLength: 255
minLength: 0
nullable: true
type: string
configName:
maxLength: 255
minLength: 0
nullable: true
type: string
configVersion:
maxLength: 255
minLength: 0
nullable: true
type: string
hardware:
maxLength: 255
minLength: 0
nullable: true
type: string
hardwareCode:
maxLength: 255
minLength: 0
nullable: true
type: string
hardwareVersion:
maxLength: 255
minLength: 0
nullable: true
type: string
firmwareVersion:
maxLength: 255
minLength: 0
nullable: true
type: string
osName:
maxLength: 255
minLength: 0
nullable: true
type: string
osVersion:
maxLength: 255
minLength: 0
nullable: true
type: string
appName:
maxLength: 255
minLength: 0
nullable: true
type: string
appVersion:
maxLength: 255
minLength: 0
nullable: true
type: string
packageName:
maxLength: 255
minLength: 0
nullable: true
type: string
packageVersion:
maxLength: 255
minLength: 0
nullable: true
type: string
libixagentVersion:
maxLength: 255
minLength: 0
nullable: true
type: string
libixloggerVersion:
maxLength: 255
minLength: 0
nullable: true
type: string
logOnTrigger:
nullable: false
type: boolean
alarming:
nullable: false
type: boolean
dataMonitoring:
nullable: false
type: boolean
wifi:
nullable: false
type: boolean
remoteFirmwareUpgrade:
nullable: false
type: boolean
staticMapping:
nullable: false
type: boolean
stewardConfigPush:
nullable: false
type: boolean
wanInterfaceEth0:
nullable: false
type: boolean
wanInterfaceWifi0:
nullable: false
type: boolean
wanInterfaceCell0:
enum:
- 3G
- 4G
- neither
nullable: false
type: string
multiWan:
nullable: false
type: boolean
openvpnVersion:
maxLength: 255
minLength: 0
nullable: true
type: string
openvpnOccEnabled:
nullable: false
type: boolean
openvpnOpensslVersion:
maxLength: 255
minLength: 0
nullable: true
type: string
networkValues:
type: array
items:
nullable: false
type: object
properties:
interface:
maxLength: 255
minLength: 1
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
value:
type: array
items:
maxLength: 255
minLength: 0
nullable: false
type: string
networkReportedOn:
nullable: true
type: string
format: date-time
activeStatus:
enum:
- active
- inactive
nullable: false
type: string
activationLicence:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
type:
nullable: false
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
usageType:
enum:
- 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
nullable: false
type: string
companyLimit:
maximum: 4294967295
nullable: true
type: integer
format: int32
scope:
enum:
- agent
- company
nullable: false
type: string
serialNumber:
maxLength: 255
minLength: 1
nullable: false
type: string
expiresOn:
nullable: true
type: string
format: date-time
activated:
nullable: false
type: boolean
trial:
nullable: false
type: boolean
value:
maxLength: 255
minLength: 1
nullable: true
type: string
locked:
nullable: true
type: boolean
maxRetentionPolicy:
maxLength: 255
minLength: 2
nullable: true
type: string
bundle:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
pendingRegistration:
nullable: false
type: boolean
card:
nullable: true
type: object
properties:
publicId:
nullable: false
type: string
activeVpnSession:
nullable: true
type: object
properties:
rscServer:
nullable: false
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
vpnRange:
maxLength: 255
minLength: 1
nullable: false
type: string
supportedLayers:
type: array
items:
enum:
- tun
- tap
nullable: false
type: string
location:
nullable: false
type: object
properties:
name:
maxLength: 255
minLength: 1
nullable: false
type: string
latitude:
nullable: false
type: string
longitude:
nullable: false
type: string
startedOn:
nullable: false
type: string
format: date-time
sessionName:
maxLength: 255
minLength: 1
nullable: false
type: string
vpnAddress:
maxLength: 255
minLength: 0
nullable: true
type: string
closed:
nullable: false
type: boolean
vpnChangedOn:
nullable: true
type: string
format: date-time
mdrServer:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
mqttChangedOn:
nullable: true
type: string
format: date-time
loggingMdrServer:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
loggingMqttChangedOn:
nullable: true
type: string
format: date-time
lsiServer:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
company:
nullable: false
type: object
properties:
publicId:
maxLength: 24
minLength: 24
nullable: false
pattern: (\d{4}-){4}\d{4}
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
controlledBy:
nullable: true
type: object
properties:
publicId:
maxLength: 24
minLength: 24
nullable: false
pattern: (\d{4}-){4}\d{4}
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
vpnAudience:
nullable: false
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
description:
maxLength: 255
minLength: 0
nullable: true
type: string
custom:
nullable: false
type: object
default:
nullable: false
type: boolean
type:
enum:
- alarm
- page
- service
nullable: true
type: string
vpnRequireAccessApproval:
nullable: false
type: boolean
vpnAccessRules:
type: array
items:
nullable: false
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
agent:
nullable: false
type: object
properties:
publicId:
nullable: false
type: string
audience:
nullable: false
type: object
properties:
publicId:
nullable: false
type: string
ipAddress:
maxLength: 255
minLength: 0
nullable: false
type: string
netMask:
maxLength: 255
minLength: 0
nullable: false
type: string
vpnVisibleInMobileApp:
nullable: false
type: boolean
vpnVisibleOnWeb:
nullable: false
type: boolean
dataAudience:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
descripti
# --- truncated at 32 KB (159 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ixon/refs/heads/main/openapi/ixon-agent-api-openapi.yml