---
title: "List Appliance Support Status"
method: GET
path: "/configuration/support/appliances"
tags: ["Supportability"]
---

# List Appliance Support Status

`GET /configuration/support/appliances`

## Request

- Base URL: `https://am1.portal.api.nasuni.com`
- URL: `https://am1.portal.api.nasuni.com/configuration/support/appliances`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nasuni/apis/portal-api/docs/configuration/support/appliances/get.ts> (a function with typed inputs; its response is checked against the schema)

This functionality is not generally available in Portal. Customers should use the equivalent NMC APIs to maintain a single management experience. Customers who require access to these Portal APIs should contact their Nasuni Account Manager to discuss eligibility. Nasuni Edge Appliance v10.5 or later is required.

Optional filters include `search` (case-insensitive appliance name substring), `enabled` (remote-support state), and `appliance_ids` (specific appliances). Results are cursor-paginated: to fetch the next page, reuse the same filter, sort, and limit values with the prior response's `iterator_id`.

## Query parameters

- `search` string, nullable
- `enabled` boolean[], nullable: Filter by remote-support enabled state
- `appliance_ids` string[], nullable: Restrict to these appliance UUIDs
- `sort_by` 'appliance_name' | 'enabled' | 'duration_hours' | 'support_connected' | 'last_diagnostics_initiated_at': Sortable columns for the appliance support list — mirror the frontend table headers.
- `sort_direction` 'ascending' | 'descending'
- `iterator_id` string, uuid, nullable: Cursor from a prior response's metadata. When set, resend the same search/enabled/appliance_ids/sort_by/sort_direction/limit used to create the cursor (only 'page' may be omitted); a mismatch returns 400.
- `limit` integer
- `page` integer, nullable

## Response `200`

Appliance support status retrieved successfully

- ApplianceSupportListDto
  - `items` ApplianceSupportStateDto[]
    - `appliance_id` string, uuid, required
    - `appliance_name` string, nullable
    - `enabled` boolean
    - `status` 'inactive' | 'active' | 'expired': Per-appliance support session state. Derived at query time, never stored.
    - `duration_hours` integer, nullable
    - `expires_at` string, date-time, nullable
    - `support_connected` boolean
    - `tasks` ApplianceSupportTaskDto[]
      - `id` string, uuid, required
      - `created_at` string, date-time, required
      - `resource` string, required
      - `resource_id` union
        - string, uuid
        - string
      - `action` string, required
      - `executor_id` string, uuid, nullable
      - `state` 'in_progress' | 'completed' | 'failed', required
      - `reason` string, nullable
      - `can_acknowledge` boolean
    - `last_diagnostics_initiated_at` string, date-time, nullable
    - `configurable` boolean
  - `metadata` ApplianceSupportPaginationMetadataDto, required: Pagination metadata for appliance support list responses.
    - `iterator_id` string, uuid, nullable: Iterator ID for loading more results (null if no more)
    - `page_size` integer: Number of items per page
    - `total_pages` integer, nullable: Total number of pages (null if unknown)
    - `total_items` integer, required: Total number of items matching the query
    - `page` integer, nullable: Current page number (1-based)

## Other responses

- `401`: Not authenticated
- `403`: Insufficient permissions
- `422`: Invalid input data
- `500`: Internal server error

---

[API](https://skmtc.dev/nasuni/apis/portal-api.md) - [All operations](https://skmtc.dev/nasuni/apis/portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nasuni/apis/portal-api/revisions/2a505bec6d14?raw)