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 pool deployments API

The Host pool deployments API from ControlUp — 1 operation(s) for host pool deployments.

ControlUp Host pool deployments 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 pool deployments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 13 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.

1 operations 1 paths 13 schemas 1 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 pool deployments 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Host pool deployments 1
POST
/cloud/subscriptions/{subscriptionId}/host-pool-deployments
Create host pool deployment
CreateHostPoolDeployment 1 param body → 201400401402403404409500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are SaveHostPoolVmSettingsRequest (30 properties), CreateHostPoolDeploymentRequest (13 properties), ErrorResponse (7 properties), JobCreatedDto (7 properties). Each schema is shown below with its type and property counts.

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
SaveHostPoolVmSettingsRequest
object
Full request payload for creating or replacing VM settings for a host pool.
30 properties 19 required
HostPoolAppGroupType
string
Azure Virtual Desktop application group type for host pools.
HostPoolVmJoinType
string
Directory join strategy for session host VMs.
HostPoolVmImageSource
string
Image source selection for host pool VM settings.
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.
HostPoolLoadBalancingAlgorithm
string
Azure Virtual Desktop load balancing algorithm for host pool session distribution.
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
VmSecurityType
string
Security profile for Azure VMs.
HostPoolVmNetworkSecurityGroup
string
Network security group preset for host pool VM settings.
HostPoolType
string
Represents the type of Azure Virtual Desktop host pool.
CreateHostPoolDeploymentRequest
object
Request to create an Azure Virtual Desktop host pool shell deployment.
13 properties 6 required
HostPoolAssignmentType
string
Assignment strategy for personal Azure Virtual Desktop host pools.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

controlup-host-pool-deployments-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 pool deployments 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.