inventory__list_workspace_hosts
Retrieve all hosts assigned to a workspace by providing its workspace ID. Apply filters like FQDN, tags, or staleness to narrow down the inventory.
Instructions
List hosts that belong to a workspace.
Use list_workspaces first to obtain the workspace ID. Required permission: inventory:hosts:read (Inventory Hosts viewer).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fqdn | No | Filter by FQDN (case-insensitive). | |
| page | No | Page number to return. | |
| tags | No | Filter by tags (e.g., 'ns1/key1=val1,ns2/key2=val2'). | |
| order_by | No | Field to sort by ('display_name', 'updated', 'created'). | |
| per_page | No | Number of hosts to return per page **ALWAYS use the default value of 10 for the first call.** Only increase this value if the user explicitly asks to see more systems at once. | |
| order_how | No | Sort direction ('ASC' or 'DESC'). | ASC |
| staleness | No | Filter by staleness status (one of 'fresh', 'stale', 'stale_warning', 'unknown'). | |
| display_name | No | Filter by display name (case-insensitive). | |
| workspace_id | Yes | Workspace ID (UUID) whose hosts to list. | |
| hostname_or_id | No | Filter by display_name, fqdn, or id (case-insensitive). | |
| registered_with | No | Filter by reporter that registered the host. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |