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 VM settings API

The Host pool VM settings API from ControlUp — 2 operation(s) for host pool vm settings.

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

This API exposes 4 operations across 2 paths, and defines 19 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.

4 operations 2 paths 19 schemas 1 DELETE1 GET1 POST1 PUT

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 VM settings 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 4

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

Host pool VM settings 4
GET
/cloud/host-pools/{hostPoolId}/vm-settings
Get VM settings for a host pool
GetHostPoolVmSettings 1 param → 200204401402403404500503
PUT
/cloud/host-pools/{hostPoolId}/vm-settings
Create or replace VM settings for a host pool
SaveHostPoolVmSettings 1 param body → 200400401402403404500503
DELETE
/cloud/host-pools/{hostPoolId}/vm-settings
Delete VM settings for a host pool
DeleteHostPoolVmSettings 1 param → 204401402403404500503
POST
/cloud/host-pools/{hostPoolId}/vm-settings/validation
Validate VM settings for a host pool
ValidateHostPoolVmSettings 1 param body → 200204400401402403404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are HostPoolVmSettingsDto (32 properties), SaveHostPoolVmSettingsRequest (30 properties), LookedUpImageDto (26 properties), VmSizeDto (25 properties). Each schema is shown below with its type and property counts.

LookedUpVirtualMachineDto
object
Represents a looked-up virtual machine resource with promoted VM-specific properties.
12 properties 12 required
HostPoolVmNetworkSecurityGroup
string
Network security group preset for host pool VM settings.
VmSizeDto
object
Data transfer object representing a virtual machine size/SKU. Contains specifications and capabilities for capacity planning and provisioning.
25 properties 17 required
HostPoolVmSettingsDetailsDto
object
Enriched lookup/resource details for host pool VM settings.
11 properties
HostPoolVmSettingsDto
object
VM settings response for a host pool. Secret values are never returned in plaintext.
32 properties 20 required
ImageSourceType
string
Represents the source type of a virtual machine image.
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
LookedUpResourceGroupDto
object
Represents a looked-up Azure resource group. Resource groups are containers, not resources — they derive from the entity base rather than the resource DTO sinc…
6 properties 6 required
LookedUpVirtualNetworkSubnetDto
object
Represents a looked-up subnet in a virtual network.
4 properties 3 required
LookedUpVirtualNetworkDto
object
Represents a looked-up virtual network resource.
8 properties 8 required
HostPoolVmJoinType
string
Directory join strategy for session host VMs.
LookedUpImageDto
object
Represents a looked-up image resource.
26 properties 11 required
SaveHostPoolVmSettingsRequest
object
Full request payload for creating or replacing VM settings for a host pool.
30 properties 19 required
HostPoolVmImageSource
string
Image source selection for host pool VM settings.
VmSecurityType
string
Security profile for Azure VMs.
DiskSizeDto
object
A flat OS disk size option row for VM-size catalog responses.
7 properties 4 required
DiscoverableResourceType
string
Public API enum for resource types that users can discover/import. Only includes high-level resource types exposed to end users.
RegionMetadataDto
object
Region metadata for a subscription.
7 properties 3 required
LookedUpGalleryImageVersionDto
object
Represents a looked-up gallery image version resource.
15 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

controlup-host-pool-vm-settings-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 VM settings 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.