Query parameters

• page integer

  Page number

  Minimum value is 1. Default value is 1.

• page_size integer

  Items per page

  Minimum value is 1, maximum value is 100. Default value is 20.

• search string

  Search term

  Minimum length is 1.

• sort_by string

  Field to sort systems by

  Values are name, type, status, fqdn, version, system_key, created_at, updated_at, creator_name, or organization_name.

• sort_direction string

  Sort direction

  Values are asc or desc. Default value is asc.

• name string

  Filter systems by name (case-insensitive, partial match)

• system_key string

  Filter systems by system key (exact match). Useful for exporting a single system.

• type array[string]

  Filter systems by type/product (exact match). Supports multiple values for checkbox filtering.

• created_by array[string]

  Filter systems by creator user ID or creator organization ID (exact match). Each provided ID is checked against both the user_id and organization_id fields of the system creator. Supports multiple values for checkbox filtering.

  Examples:

  • ?created_by=53h5zxpwu4vc - matches systems created by user with ID 53h5zxpwu4vc
  • ?created_by=lbswt1rxdhbz - matches systems created by users in organization lbswt1rxdhbz
  • ?created_by=53h5zxpwu4vc&created_by=lbswt1rxdhbz - matches systems created by the user OR by users in the organization
• version array[string]

  Filter systems by version using prefixed format product:version (e.g., nsec:8.0, ns8:1.2.3). The prefix prevents ambiguity when the same version number exists for multiple products. Supports multiple values for checkbox filtering.

  Example: ?version=nsec:8.0&version=ns8:1.2.3 matches systems with (nsec version 8.0) OR (ns8 version 1.2.3)

  Backward compatibility: Non-prefixed versions (e.g., 8.0) are still supported but may match multiple products.

• organization_id array[string]

  Filter systems by organization ID (exact match). Supports multiple values for checkbox filtering.

• status array[string]

  Filter systems by status (exact match). Supports multiple values for checkbox filtering.

  Special value "deleted" shows soft-deleted systems (where deleted_at IS NOT NULL). When "deleted" is combined with other statuses, both deleted and non-deleted systems matching the other statuses are returned.

  Values are unknown, online, offline, or deleted.

Responses

• 200 application/json

  Systems retrieved successfully

  Hide response attributes Show response attributes object

  • code integer
  • message string
  • data object
    Hide data attributes Show data attributes object

    • systems array[object]
      Hide systems attributes Show systems attributes object

      • id string

        System ID

      • name string

        System name

      • type string | null

        System type (auto-detected by collect service, null until first inventory collection)

        Values are ns8 or nsec.

      • status string

        System operational status (defaults to 'unknown', auto-updated by collect service)

        Values are unknown, online, offline, or deleted.

      • fqdn string

        Fully qualified domain name

      • ipv4_address string

        IPv4 address

      • ipv6_address string

        IPv6 address

      • version string

        System version

      • system_key string

        Auto-generated unique commercial system key. Hidden (empty string) until system is registered.

      • organization_id string

        Organization ID to which this system belongs

      • organization_name string

        Organization name to which this system belongs (resolved from distributors, resellers, or customers)

      • custom_data object

        Custom system data

        Additional properties are allowed.

      • system_secret string

        Auto-generated system secret token in format my_. (only returned during creation/regeneration, never stored or displayed again)

      • notes string

        Additional notes or description for the system

      • created_at string(date-time)

        System creation timestamp

      • updated_at string(date-time)

        System last update timestamp

      • created_by object
        Hide created_by attributes Show created_by attributes object

        • user_id string

          User ID who created the system

        • name string

          Full name of the user who created the system

        • email string

          Email of the user who created the system

        • organization_id string

          Organization ID of the creator

        • organization_name string

          Organization name of the creator

      • heartbeat_status string

        System heartbeat status (alive=<15min, dead=>15min, zombie=never communicated)

        Values are alive, dead, or zombie.

      • last_heartbeat string(date-time)

        Last heartbeat timestamp

      • heartbeat_minutes integer

        Minutes since last heartbeat

      • registered_at string(date-time) | null

        Registration timestamp. NULL means not yet registered, non-NULL means system registered at that time. When NULL, system_key is hidden.

    • pagination object
      Hide pagination attributes Show pagination attributes object

      • page integer

        Current page number

        Minimum value is 1.

      • page_size integer

        Number of items per page

        Minimum value is 1, maximum value is 100.

      • total_count integer

        Total number of items

        Minimum value is 0.

      • total_pages integer

        Total number of pages

        Minimum value is 0.

      • has_next boolean

        Whether there is a next page

      • has_prev boolean

        Whether there is a previous page

      • next_page integer | null

        Next page number if available

      • prev_page integer | null

        Previous page number if available

      • sort_by string | null

        Field used for sorting

      • sort_direction string | null

        Sort direction

        Values are asc or desc.

• 401 application/json

  Unauthorized - invalid or missing token

  Hide response attributes Show response attributes object

  • code integer
  • message string
  • data object | null
• 403 application/json

  Forbidden - insufficient permissions

  Hide response attributes Show response attributes object

  • code integer
  • message string
  • data object | null