Get overview host pools

get

https://api.controlup.com/daas-iq/v1/cloud/overview/host-pools

Returns one row per host pool with host statistics, session counts, cost, and performance metrics.
Carries cost and accepts filters from any level of the hierarchy; the plain host pool list is the one for simply
enumerating pools. Neither carries AVD configuration or time-series metrics.

Query Params

provider

string

enum

Filter by cloud provider. Currently only Azure is supported.

Allowed:

subscriptionId

uuid

Filter by cloud subscription (internal ID).

regionId

string

length ≤ 100

Filter by Azure region code (e.g., 'eastus', 'westeurope').

resourceGroupId

uuid

Filter by resource group (internal ID).

workspaceId

uuid

Filter by workspace (internal ID).

applicationGroupId

uuid

Filter by application group (internal ID).

hostPoolId

uuid

Filter by host pool (internal ID).

sessionHostId

uuid

Filter by session host (internal ID).

userSessionId

uuid

Filter by user session (internal ID).

imageId

uuid

Filter by image (internal ID).

masterImageId

uuid

Filter by master image (internal ID).

page

int32

1 to 2147483647

The page number to retrieve (1-based). Default: 1.

pageSize

int32

1 to 100

The number of items per page (1-100). Default: 50.

Responses

200Successfully retrieved host pools.

400Bad request. Invalid pagination parameters.

401Unauthorized. User is not authenticated.

402Payment required. No active license for the organization.

403Forbidden. User does not have access to this organization.

500Internal server error.

503Service unavailable. License status could not be verified. Try again later.