Skip to main content
📣 Try Nexigon today — sign up for a free account, no credit card required. 📣
Nexigon Docs
Documentation

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.

    ProjectIdstring
  • namerequired

    Name of the property.

    string
  • valuerequired

    Value of the property.

    JsonValueany

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.

    ProjectIdstring
  • namerequired

    Name of the property.

    string

Response GetFleetPropertyOutput

Casesinternally — 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)

    • namerequired

      Name of the property.

      string
    • valuerequired

      Current value.

      JsonValueany
    • kindrequired

      How this property is managed.

      FleetPropertyKind

      Casesinternally — 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" }

    • versionrequired

      Incremental version number, bumped on each update.

      integer (i64)
    • erroroptional

      Error from the last computation attempt, if any.

      string
    • lastUpdated(from last_updated)required

      When the value was last updated.

      Timestampstring

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.

    ProjectIdstring
  • namerequired

    Name of the property.

    string

Response RemoveFleetPropertyOutput

Casesinternally — 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.

    ProjectIdstring

Response QueryFleetPropertiesOutput

Fields (JSON object)

  • propertiesrequired

    Properties keyed by name.

    object<string, FleetProperty>

    Keys

    string

    Values

    FleetProperty

    Fields (JSON object)

    • namerequired

      Name of the property.

      string
    • valuerequired

      Current value.

      JsonValueany
    • kindrequired

      How this property is managed.

      FleetPropertyKind

      Casesinternally — 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" }

    • versionrequired

      Incremental version number, bumped on each update.

      integer (i64)
    • erroroptional

      Error from the last computation attempt, if any.

      string
    • lastUpdated(from last_updated)required

      When the value was last updated.

      Timestampstring

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.

    ProjectIdstring
  • namerequired

    Name of the property.

    string
  • inputProperties(from input_properties)required

    Device property names fed into the strategy's map function.

    array<string>

    Items

    string
  • strategyrequired

    Name of the computation strategy.

    string
  • configoptional

    Strategy-specific configuration.

    JsonValueany

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.

    ProjectIdstring

Response QueryComputedFleetPropertyDefinitionsOutput

Fields (JSON object)

  • definitionsrequired

    List of definitions.

    array<ComputedFleetPropertyDefinition>

    Items

    ComputedFleetPropertyDefinition

    Fields (JSON object)

    • namerequired

      Name of the property.

      string
    • inputProperties(from input_properties)required

      Device property names fed into the strategy's map function.

      array<string>

      Items

      string
    • strategyrequired

      Name of the computation strategy.

      string
    • configrequired

      Strategy-specific configuration.

      JsonValueany
    • createdAt(from created_at)required

      When the definition was created.

      Timestampstring