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 applications by

  Values are display_name, module_id, instance_of, version, status, created_at, updated_at, last_inventory_at, system_name, or organization_name.

• sort_direction string

  Sort direction

  Values are asc or desc. Default value is asc.

• type array[string]

  Filter applications by type (instance_of). Supports multiple values.

• version array[string]

  Filter applications by version. Supports multiple values. Uses prefixed format "application:version" (e.g., "nethvoice:1.5.3") to avoid ambiguity when the same version exists for multiple application types.

• system_id array[string]

  Filter applications by system ID. Supports multiple values.

• organization_id array[string]

  Filter applications by organization ID. Supports multiple values.

• status array[string]

  Filter applications by assignment status. Supports multiple values.

  Values are unassigned or assigned.

Responses

• 200 application/json

  Applications retrieved successfully

  Hide response attributes Show response attributes object

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

    • applications array[object]

      Simplified application representation for list views

      Hide applications attributes Show applications attributes object

      • id string

        Unique application identifier

      • module_id string

        Module identifier

      • instance_of string

        Application type

      • name string | null

        Human-readable label from inventory (e.g., "Nextcloud")

      • source string | null

        Image source from inventory (e.g., "ghcr.io/nethserver/nextcloud")

      • display_name string | null

        User-friendly name set in NS8 and inherited from inventory

      • version string | null

        Application version

      • status string

        Assignment status

        Values are unassigned or assigned.

      • node_id integer | null

        Node ID within the cluster

      • node_label string | null

        Node label from inventory (e.g., Leader Node, Worker Node)

      • url string | null

        Custom URL for the application

      • notes string | null

        Custom notes or description for the application

      • has_errors boolean

        Whether the application has service errors

      • inventory_data object | null

        Raw inventory data from the module (e.g., NethVoice proxy, Open LDAP domain, etc.)

      • backup_data object | null

        Backup status information

      • services_data object | null

        Service health status information with errors list

      • system object

        Minimal system info for application responses

        Hide system attributes Show system attributes object

        • id string

          System ID

        • name string

          System name

      • organization object

        Simplified organization for selection and assignment

        Hide organization attributes Show organization attributes object

        • id string

          Database UUID of the organization (or "no_org" for unassigned filter)

        • logto_id string

          Logto organization ID (or "no_org" for unassigned filter)

        • name string

          Organization name

        • description string

          Organization description

        • type string

          Organization type ("unassigned" is the special "No organization" filter entry)

          Values are owner, distributor, reseller, customer, or unassigned.

      • created_at string(date-time)

        Record creation timestamp

      • last_inventory_at string(date-time) | null

        Last inventory collection timestamp

    • 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