For AI agents: visit https://developer.ixon.cloud/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

| Developer Documentation

Home Documentation Recipes Endpoint List Release Notes

| Developer Documentation Support Site Roadmap Status Page Privacy Log In

Documentation

Support Site Roadmap Status Page Privacy Log In

Home Documentation Recipes Endpoint List Release Notes

IXON API Overview

IXON API prerequisites
IXON API Authentication
- Service Accounts access tokens
- User access tokens
Common errors
API rate limits
How to keep the query data up-to-date

IXON API Knowledge

Manage groups, users, roles and more
Manage devices
Manage assets
Manage custom properties
Manage access requests
Manage MQTT Brokers and clients
A guide to data mapping in IXON Cloud
Understanding historical data
How to use live data?
Add a username to a request for logging and auditing
How to integrate WebAccess in a custom application
How to add a trusted device / prevent manual 2FA codes
How to check if an Agent is online
How to check how long an agent has been offline
How to push a configuration to an agent

IXON API Code Tutorials

How to retrieve historical data using the DataList endpoint
How to retrieve historical data from InfluxDB via direct access
How to implement a custom SSO authentication login flow

VPN Client API

How to use the VPN Client API
Set up a VPN Connection
VPN Client status
Configure the VPN Client

IXrouter3 API

Introduction
How to authenticate to the API
How to get an overview of the state of the device
How to get or set the configuration
How to change the password of the admin user
How to get hardware information
How to reboot the device

SecureEdge API

SecureEdge API
How to authenticate to the API
How to get or set the configuration
How to interact with Docker
How to get GPS coordinates
How to send an SMS
How to get system info
How to get the connection status

Edge Apps

Edge Apps explained
How to overwrite an Edge App's files

App Engine - UI Components and Cloud Functions

What is the App Engine?
UI Components: when to use them
Cloud Functions: when to use them

UI Components

Getting started
Simulator
Manifest file
- Component inputs
- Component settings
Component Context API
Design tokens
Component SDK
- Common pitfalls
Advanced
Tips and tricks

Cloud Functions

Cloud Functions Basics
Development of Cloud Functions
Cloud Functions SDK
Common errors
- Local development errors
- Docker errors

IXON SDK Code Tutorials

IXON SDK UI Components Tutorials
IXON SDK Cloud Functions Tutorials
- How to customize Service Logbook with import/export functionalities using JSON

Development Documentation

MCP

Powered by

Getting started

In this section, we’ll discuss installing the required tooling and how to create your UI Components.

Updated about 1 year ago

Cloud Functions: when to use them

Did this page help you?