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, created_at, updated_at, last_seen, or creator_name.

• sort_direction string

  Sort direction

  Values are asc or desc. Default value is asc.

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

        System type

      • status string

        System operational status

        Values are online, offline, or maintenance.

      • fqdn string

        Fully qualified domain name

      • ipv4_address string

        IPv4 address

      • ipv6_address string

        IPv6 address

      • version string

        System version

      • last_seen string(date-time)

        Last seen timestamp from inventory

      • custom_data object

        Custom system data

        Additional properties are allowed.

      • secret_hint string

        Last 4 characters of system secret for identification

      • 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

        • user_name string

          Username 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

    • 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