Nexigon Hub API
Reference of the actions that devices, tools, and integrations invoke on Nexigon Hub.
Nexigon Hub provides its functionality as actions. An action has a name, a JSON request, and a JSON response. The name consists of a namespace and an operation, such as devices_GetProperty in the devices namespace. Clients invoke an action with a POST request to /api/v1/actions/invoke/<action>.
For example, read a device property with the URL of your Nexigon Hub instance, such as https://eu.nexigon.cloud, in NEXIGON_HUB_URL and an API token in NEXIGON_TOKEN:
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"deviceId":"<device-id>","name":"dev.example.config"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/devices_GetProperty{
"result": "Found",
"name": "dev.example.config",
"value": {
"interval": 60
},
"protected": false,
"version": 3,
"lastUpdated": "2026-01-01T12:00:00Z"
}The Actions API reference explains authentication, errors, and pagination. This reference documents the request and response of every action. It is generated from the same Sidex definitions as the OpenAPI definition and the SDKs.
Compatibility
Actions can change in backward-incompatible ways between Nexigon Hub releases, but such changes are rare. The actions of two APIs deviate from this, and the reference shows their API as a badge. The APIs do not restrict who can invoke an action: with the required permissions, an integration can, for example, set a device property with the Device API action devices_SetProperty.
Device API
Software on devices invokes these actions, usually through Nexigon Agent, for example, to report properties and events, execute device operations, and download system updates. Devices stay in the field for years, so these actions remain backward compatible for at least five years.
On devices running Nexigon Agent, software invokes these actions through the agent's commands, which authenticate as the device. For example, nexigon-agent device properties set invokes devices_SetProperty. The references for properties, telemetry, and device tokens describe these commands.
The Device API consists of these actions:
actor_GetActordevices_IssueDeviceTokendevices_PublishEventsdevices_SetPropertydevices_GetPropertydevices_ClaimOperationWorkdevices_ReportOperationStepprojects_RedeemDevicePairingKeyrepositories_ResolveVersionByPathrepositories_GetVersionDetailsrepositories_ResolveVersionAssetByPathrepositories_IssueAssetDownloadUrl
Admin API
These actions administer a Nexigon Hub instance, for example, its users and organizations. They require instance administrator permissions. Backward-incompatible changes are more frequent than for other actions.
Namespaces
The reference has a page for each namespace:
- Actor: 1 action
- Audit: 2 actions
- Devices: 34 actions
- Fleet: 18 actions
- Groups: 4 actions
- Instance: 3 actions
- Jobs: 1 action
- Organizations: 18 actions
- Profiles: 15 actions
- Projects: 24 actions
- Repositories: 53 actions
- Users: 27 actions
Reading the Reference
- Field names are the keys of JSON objects. Fields are required unless marked optional.
- Types are JSON types. A name after a type, such as
DeviceId, names the type in the Sidex definitions and SDKs. The headings of requests and responses name their types, such asGetDevicePropertyAction. - Integers marked 64-bit are numbers or, beyond ±(253 − 1), decimal strings, so that they stay exact in languages such as JavaScript.
- Many responses are one of several results, identified by the
resultfield. An HTTP200response can contain a result such asNotFound, as described in Responses and Errors. - Examples use placeholders in angle brackets, such as
<device-id>, and contain only required fields.