ControlUp Overview API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
An API key is passed in the cookie as user_dex_token (CookieAuth).
BearerAuth — API Key Authentication (Recommended) [Learn how to create an API key](https://api.controlup.io/reference/how-to-create-api-keys).
CookieAuth — Cookie Authentication (Browser use) ⚠️ The 'Authorize' button cannot set cookies due to browser security. To authenticate in browser: 1. Login via DEX authenti…
Paths & Operations 11
Across 11 paths, the API surfaces 11 operations — 11 GET. Each is listed below with its method, path, parameters, and response codes.
The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are SessionHostOverview (22 properties), OverviewUserSessionResult (18 properties), ApplicationGroupOverview (17 properties), MasterImageOverview (17 properties). Each schema is shown below with its type and property counts.
WorkspaceOverview
object
Workspace summary with metrics for the overview page. Workspaces represent the top-level user experience in Azure Virtual Desktop. They group Application Group…
13 properties13 required
MasterImageOverviewPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties5 required
RegionOverviewPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties5 required
SubscriptionOverview
object
Subscription summary with aggregated metrics for the overview page.
12 properties12 required
WorkspaceOverviewPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties5 required
SessionHostOverviewPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties5 required
SubscriptionOverviewPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties5 required
SessionHostOverview
object
Session host summary with metrics for the overview page.
22 properties22 required
ApplicationGroupOverview
object
Application group summary with metrics for the overview page. Application Groups are collections of RemoteApp programs or Desktops published to users.
17 properties14 required
CloudProvider
string
Enumeration of supported cloud provider identifiers.
ErrorResponse
object
Standard error body the API returns when a request fails validation or cannot be completed. Follows RFC 7807 Problem Details with additional errors and traceId…
7 properties3 required
OverviewUserSessionResult
object
Extended user session result for overview display. Includes denormalized host pool, subscription, and region information.
18 properties16 required
RegionOverview
object
Region summary with aggregated metrics for the overview page.
11 properties11 required
OverviewGraphData
object
Graph node data for the cloud integrations overview visualization. Each instance represents a count of entities at a specific level in the hierarchy.
3 properties1 required
MasterImageOverview
object
Read-only overview projection for a Foundry-managed master image.
17 properties14 required
ResourceGroupOverview
object
Resource group summary with aggregated metrics for the overview page.
14 properties14 required
ApplicationGroupOverviewPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties5 required
HostPoolOverview
object
Host pool summary with detailed metrics for the overview page.
16 properties15 required
ImageOverview
object
Image summary with usage statistics for the overview page.
11 properties11 required
OverviewUserSessionResultPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties5 required
ImageOverviewPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties5 required
ResourceGroupOverviewPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties5 required
HostPoolOverviewPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of ControlUp Overview API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
