Fleet API

Actions in the fleet namespace of the Nexigon Hub API.

`fleet_SetProperty`

POST /api/v1/actions/invoke/fleet_SetProperty

Set a fleet property manually.

Request SetFleetPropertyAction

Fields (JSON object)

projectId (from project_id) required
ID of the project.

ProjectId string
name required
Name of the property.

string
value required
Value of the property.

JsonValue any

Response Empty

No fields.

`fleet_GetProperty`

POST /api/v1/actions/invoke/fleet_GetProperty

Get a fleet property by name.

Request GetFleetPropertyAction

Fields (JSON object)

projectId (from project_id) required
ID of the project.

ProjectId string
name required
Name of the property.

string

Response GetFleetPropertyOutput

Cases internally — tag field result

NotFound
The property was not found.

{ "result": "NotFound" }
Found
The property was found.

{ "result": "Found", ...<payload fields> } — or "content" for non-object payloads
FleetProperty
Fields (JSON object)
- name required
  Name of the property.
  
  string
- value required
  Current value.
  
  JsonValue any
- kind required
  How this property is managed.
  
  FleetPropertyKind
  
  Cases internally — tag field kind
  Manual
  Set manually via the API.
  
  { "kind": "Manual" }
  Computed
  Computed from device properties via a user-defined strategy.
  
  { "kind": "Computed" }
  Builtin
  Computed from device properties via a built-in strategy.
  
  { "kind": "Builtin" }
- version required
  Incremental version number, bumped on each update.
  
  integer (i64)
- error optional
  Error from the last computation attempt, if any.
  
  string
- lastUpdated (from last_updated) required
  When the value was last updated.
  
  Timestamp string

`fleet_RemoveProperty`

POST /api/v1/actions/invoke/fleet_RemoveProperty

Remove a fleet property.

Handles both manual and computed properties. For computed properties, the associated definition is removed as well.

Request RemoveFleetPropertyAction

Fields (JSON object)

projectId (from project_id) required
ID of the project.

ProjectId string
name required
Name of the property.

string

Response RemoveFleetPropertyOutput

Cases internally — tag field result

NotFound
The property was not found.

{ "result": "NotFound" }
Removed
The property was removed.

{ "result": "Removed" }

`fleet_QueryProperties`

POST /api/v1/actions/invoke/fleet_QueryProperties

Query all fleet properties of a project.

Request QueryFleetPropertiesAction

Fields (JSON object)

projectId (from project_id) required
ID of the project.

ProjectId string

Response QueryFleetPropertiesOutput

Fields (JSON object)

properties required
Properties keyed by name.
object<string, FleetProperty>
Keys

string

Values
FleetProperty
Fields (JSON object)
name required
Name of the property.

string

value required
Current value.

JsonValue any

kind required
How this property is managed.

FleetPropertyKind

Cases internally — tag field kind
Manual
Set manually via the API.

{ "kind": "Manual" }
Computed
Computed from device properties via a user-defined strategy.

{ "kind": "Computed" }
Builtin
Computed from device properties via a built-in strategy.

{ "kind": "Builtin" }

version required
Incremental version number, bumped on each update.

integer (i64)

error optional
Error from the last computation attempt, if any.

string

lastUpdated (from last_updated) required
When the value was last updated.

Timestamp string

`fleet_DefineComputedProperty`

POST /api/v1/actions/invoke/fleet_DefineComputedProperty

Define a computed fleet property.

Request DefineComputedFleetPropertyAction

Fields (JSON object)

projectId (from project_id) required
ID of the project.

ProjectId string
name required
Name of the property.

string
inputProperties (from input_properties) required
Device property names fed into the strategy's map function.

array<string>

Items

string
strategy required
Name of the computation strategy.

string
config optional
Strategy-specific configuration.

JsonValue any

Response Empty

No fields.

`fleet_QueryComputedPropertyDefinitions`

POST /api/v1/actions/invoke/fleet_QueryComputedPropertyDefinitions

Query computed fleet property definitions for a project.

Request QueryComputedFleetPropertyDefinitionsAction

Fields (JSON object)

projectId (from project_id) required
ID of the project.

ProjectId string

Response QueryComputedFleetPropertyDefinitionsOutput

Fields (JSON object)

definitions required
List of definitions.
array<ComputedFleetPropertyDefinition>
Items
ComputedFleetPropertyDefinition
Fields (JSON object)
name required
Name of the property.

string

inputProperties (from input_properties) required
Device property names fed into the strategy's map function.

array<string>

Items

string

strategy required
Name of the computation strategy.

string

config required
Strategy-specific configuration.

JsonValue any

createdAt (from created_at) required
When the definition was created.

Timestamp string