API Reference

Get host pools

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

Returns a paginated, optionally sorted list of host pools for the current organization across all subscriptions.
Ordered by name (ascending) by default. Supports multi-field sorting.

Sort format: Field:direction pairs comma separated (e.g. Name:asc,TotalHosts:desc). Supported fields: Name, Subscription, ResourceGroup, Region, Type, AssignmentType, TotalHosts, RunningHosts, StoppedHosts, ActiveSessions, SyncedAt.

Query Params
string
enum

Optional cloud provider filter. Null means all providers.

Allowed:
string
length ≤ 256

Sort specification string (e.g. "Name:asc,TotalHosts:desc").
Default: "Name:asc".

string
length ≤ 512

Filter expression for filtering results. Supports JSON and RQL formats.

int32
1 to 2147483647

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

int32
1 to 100

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

Responses

500

Internal server error.

Updated 2 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

Did this page help you?