{ "opencollection": "1.0.0", "info": { "name": "DaaS IQ Overview API", "version": "v1" }, "items": [ { "info": { "name": "Overview", "type": "folder" }, "items": [ { "info": { "name": "Get overview graph data", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/graph", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one count per level of the hierarchy — subscriptions, regions, resource groups, host pools, session\nhosts, images, sessions — for the funnel at the top of the Overview.\nScalars, not rows; a level that a filter pins to one item returns its name instead of a count." }, { "info": { "name": "Get overview subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/subscriptions", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one row per subscription with counts of everything beneath it plus rolled-up cost and performance.\nWhat a subscription contains and costs, unlike its registration record, which carries no metrics." }, { "info": { "name": "Get overview regions", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/regions", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one row per Azure region holding onboarded resources, with subscription counts, resource statistics,\ncost, and performance rolled up within it.\nOnly regions in use, not the catalog of regions a subscription could deploy into." }, { "info": { "name": "Get overview resource groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/resource-groups", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one row per resource group, with host pool counts, host statistics, cost, and performance rolled up.\nOnly groups holding onboarded resources, not every group that exists in Azure." }, { "info": { "name": "Get overview host pools", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/host-pools", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one row per host pool with host statistics, session counts, cost, and performance metrics.\nCarries cost and accepts filters from any level of the hierarchy; the plain host pool list is the one for simply\nenumerating pools. Neither carries AVD configuration or time-series metrics." }, { "info": { "name": "Get overview session hosts", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/session-hosts", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one row per session host VM with power state, session count, performance metrics, and cost.\nSpans every host pool, so it answers \"which hosts anywhere are unhealthy, idle, or expensive\"." }, { "info": { "name": "Get overview images", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/images", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one row per image that onboarded resources are running, with version, status, and consumer count.\nCovers images of any origin, unlike the master image view, which covers only what DaaS IQ builds." }, { "info": { "name": "Get overview master images", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/master-images", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one row per DaaS IQ-managed Master Image with its version count and display name.\nA roll-up only; build configuration, publish history, and operation state live on the Master Images list." }, { "info": { "name": "Get overview user sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/user-sessions", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one row per current user session (Active, Pending, or Disconnected), denormalised with its host pool,\nsubscription, and region. Ordered by user principal name.\nSpans every host pool, so it answers \"where is this user connected\"." }, { "info": { "name": "Get overview application groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/application-groups", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one row per application group — the AVD object publishing RemoteApp programs or a full desktop —\nwith its type, host pool, and session statistics.\nSits between a workspace and a host pool, so it is neither what users pick nor what session hosts join." }, { "info": { "name": "Get overview workspaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.controlup.com/daas-iq/v1/cloud/overview/workspaces", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter by cloud provider. Currently only Azure is supported." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Filter by cloud subscription (internal ID)." }, { "name": "regionId", "value": "", "type": "query", "description": "Filter by Azure region code (e.g., 'eastus', 'westeurope')." }, { "name": "resourceGroupId", "value": "", "type": "query", "description": "Filter by resource group (internal ID)." }, { "name": "workspaceId", "value": "", "type": "query", "description": "Filter by workspace (internal ID)." }, { "name": "applicationGroupId", "value": "", "type": "query", "description": "Filter by application group (internal ID)." }, { "name": "hostPoolId", "value": "", "type": "query", "description": "Filter by host pool (internal ID)." }, { "name": "sessionHostId", "value": "", "type": "query", "description": "Filter by session host (internal ID)." }, { "name": "userSessionId", "value": "", "type": "query", "description": "Filter by user session (internal ID)." }, { "name": "imageId", "value": "", "type": "query", "description": "Filter by image (internal ID)." }, { "name": "masterImageId", "value": "", "type": "query", "description": "Filter by master image (internal ID)." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve (1-based). Default: 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items per page (1-100). Default: 50." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns one row per AVD workspace with its application group count, host pools, and session statistics.\nTop of the publishing hierarchy and what users see in their client; owns application groups, not hosts." } ] } ], "bundled": true }