How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ControlUp Host pools API

The Host pools API from ControlUp — 6 operation(s) for host pools.

ControlUp Host pools API is one of 61 APIs that ControlUp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Host Pools. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 6 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.controlup.com/daas-iq/v1.

7 operations 6 paths 10 schemas 1 DELETE5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.controlup.com/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

ControlUp Host pools 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 7

Across 6 paths, the API surfaces 7 operations — 1 DELETE, 5 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Host pools 7
GET
/cloud/host-pools
Get host pools
GetHostPools 5 params → 200400401402403500503
GET
/cloud/host-pools/statistics
Get host pool statistics
GetHostPoolsStatistics 2 params → 200400401402403500503
GET
/cloud/host-pools/{hostPoolId}
Get a host pool by ID
GetHostPool 1 param → 200401402403404500503
DELETE
/cloud/host-pools/{hostPoolId}
Delete host pool
DeleteHostPool 1 param → 204401402403404500503
GET
/cloud/host-pools/{hostPoolId}/details
Get host pool extended details
GetHostPoolDetails 1 param → 200401402403404500503
GET
/cloud/host-pools/{hostPoolId}/metrics
Get host pool metrics
GetHostPoolMetrics 4 params → 200400401402403404500503
POST
/cloud/host-pools/{hostPoolId}/deletion
Delete host pool from Azure
HardDeleteHostPool 1 param → 201400401402403404409500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are HostPoolDetailsResult (42 properties), HostPoolQueryResult (20 properties), HostPoolMetricsResult (7 properties), JobCreatedDto (7 properties). Each schema is shown below with its type and property counts.

HostPoolMetricsResult
object
Time-series metrics result for host pool charts. Contains multiple metric series for different chart types.
7 properties 7 required
HostPoolQueryResult
object
Provider-agnostic host pool list item (currently Azure only; future providers may reuse). Contains only fields that are presently persisted or directly calcula…
20 properties 19 required
JobCreatedDto
object
Lightweight response returned when a job is created. Contains only essential information needed to track the job. Use the statusUrl to poll for updates and job…
7 properties 7 required
HostPoolDetailsResult
object
Extended host pool details for the host pool details page. Includes summary widgets data, overview tab details, and configuration info.
42 properties 29 required
JobType
string
Defines the types of background jobs supported by the system. Each job type is processed by a specific worker and has its own parameter structure.
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 properties 3 required
MetricDataPoint
object
Single data point in a time-series metric.
2 properties 2 required
HostPoolQueryResultPagedResult
object
Represents a paginated result set with metadata for navigation. Supports traditional page-based pagination with skip/take semantics.
6 properties 5 required
HostPoolsStatistics
object
Aggregate statistics for host pools across an organization. Provides summary counts by host pool type.
6 properties 6 required
CloudProvider
string
Enumeration of supported cloud provider identifiers.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

controlup-host-pools-api-openapi.yml Raw ↑

Other APIs ControlUp publishes across the network.

ControlUp MCP Server
ControlUp Alerts API
ControlUp Alerts - Devices API
ControlUp Applications API
ControlUp Audit Log API
ControlUp Cloud providers API
ControlUp Dal API
ControlUp Data API
ControlUp Devices API
ControlUp Dynamic Query API API
ControlUp Events API
ControlUp Features API
Where this information came from

This is an independent, third-party profile of ControlUp Host pools 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.