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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ControlUp

ControlUp Master images API

The Master images API from ControlUp — 20 operation(s) for master images.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 20 operations across 20 paths, and defines 40 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.

20 operations 20 paths 40 schemas 3 DELETE10 GET7 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
Contact
ControlUp Support
Resource Areas
1

Authentication & Security 2

ControlUp Master images 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 20

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

Master images 20
POST
/cloud/master-images/{id}/actions
Execute an action on a master image
ExecuteMasterImageAction 1 param body → 201400401402403404500503
GET
/cloud/master-images/{id}/rdp
Download an RDP file for a master image
GetMasterImageRdpFile 1 param → 200400401402403404500503
GET
/cloud/master-images/os-families
Get supported OS families for Master Images
GetOsFamilies → 200401402403500503
GET
/cloud/master-images/marketplace-images
Get curated Marketplace images for deployment
GetMarketplaceImages → 200401402403500503
GET
/cloud/master-images
List Master Images
ListMasterImages 3 params → 200400401402403500503
GET
/cloud/master-images/{id}
Get Master Image by ID
GetMasterImage 1 param → 200401402403404500503
GET
/cloud/master-images/{id}/operation-state
Get Master Image operation state
GetOperationState 1 param → 200401402403404500503
GET
/cloud/master-images/{id}/decommission-plan
Get decommission plan
GetDecommissionPlan 1 param → 200401402403404500503
POST
/cloud/master-images/promote
Promote existing VM as Master Image
PromoteVmToMasterImage body → 201400401402403404500503
POST
/cloud/master-images/deploy-from-gallery
Deploy Master Image from Gallery image version
body → 201400401402403404500503
POST
/cloud/master-images/deploy-from-marketplace
Deploy Master Image from curated Marketplace
body → 201400401402403404500503
POST
/cloud/master-images/deploy-from-managed-image
Deploy Master Image from Managed Image
body → 201400401402403404500503
DELETE
/cloud/master-images/{masterImageId}
Delete Master Image
DeleteMasterImage 2 params → 202204400401402403404500
POST
/cloud/master-images/{masterImageId}/publish
Publish Master Image version
PublishMasterImageVersion 1 param body → 202400401402403404500503
GET
/cloud/master-images/{masterImageId}/versions
List Master Image versions
ListMasterImageVersions 4 params → 200400401402403404500503
GET
/cloud/master-images/{masterImageId}/versions/{versionId}/operation-state
Get Master Image version operation state
GetVersionOperationState 2 params → 200401402403404500503
GET
/cloud/master-images/{masterImageId}/versions/{versionId}/publish-artifacts/cleanup-plan
Get publish artifact cleanup plan
GetPublishCleanupPlan 2 params → 200400401402403404500503
DELETE
/cloud/master-images/{masterImageId}/versions/{versionId}
Delete Master Image version
DeleteMasterImageVersion 2 params → 202400401402403404500503
DELETE
/cloud/master-images/{masterImageId}/versions/{versionId}/publish-artifacts
Delete publish artifacts
DeletePublishArtifacts 2 params → 202400401402403404500503
POST
/cloud/master-images/{masterImageId}/versions/{versionId}/retry-publish
Retry failed Master Image version publish
RetryPublish 2 params → 201400401402403404409500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are MasterImageDto (36 properties), DeployFromGalleryRequest (18 properties), DeployFromManagedImageRequest (17 properties), DeployFromMarketplaceRequest (17 properties). Each schema is shown below with its type and property counts.

DeployFromManagedImageResponse
object
Response returned when a Deploy from Managed Image operation is initiated. Contains the created Master Image record and the background job tracking info.
2 properties 2 required
MasterImageVersionDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties 5 required
PublishMasterImageRequest
object
Request DTO for publishing a Master Image (sysprep + capture to ACG).
4 properties 2 required
PromoteMasterImageRequest
object
Request to promote (import) an existing Azure VM as a managed Master Image. Azure-derived fields (region, generation) are resolved server-side from the VM reso…
10 properties 5 required
DeployFromGalleryRequest
object
Request to deploy a new Master Image VM from an Azure Compute Gallery image version.
18 properties 10 required
OsFamily
string
Operating system family for AVD-supported Master Images. Used for AVD Agent logic and image classification. Only OS families supported by Azure Virtual Desktop…
MasterImageActionAvailabilityItemDto
object
Availability of a single Master Image action.
2 properties 1 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
MasterImageDto
object
Response DTO for a managed Master Image shown in the Image Library.
36 properties 13 required
MasterImagePublishCleanupPlanDto
object
Master Image publish artifact cleanup plan response.
6 properties 6 required
MasterImageDecommissionResourceDto
object
Resource entry in a Master Image decommission plan.
8 properties 5 required
MasterImageResourceOwnership
string
Ownership classification for a resource referenced by a Master Image.
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
MasterImageResourceExistenceStatus
string
Azure existence state for a resource shown in a Master Image cleanup or decommission plan.
MasterImageActionRequest
object
Request to execute an action on a master image.
1 property 1 required
MasterImageSourceType
string
How a Master Image was onboarded into Foundry. Determines the original import path used to create this managed image.
MasterImageOperationStateDto
object
Operation state and action availability for a Master Image.
2 properties 1 required
MasterImageDecommissionAction
string
Action Foundry will take for a resource in a Master Image decommission plan.
JobStatus
string
Generic status enum for all background jobs. Represents the lifecycle states common to all job types.
MasterImagePowerState
string
Power state of the underlying Azure VM for a Master Image. Tracked separately from ControlUp.Foundry.Domain.Enums.Cloud.MasterImageStatus because a Master Imag…
MasterImageDecommissionPlanDto
object
Master Image decommission plan response.
5 properties 5 required
MasterImageActionAvailabilityDto
object
Server-computed availability of Master Image actions.
5 properties 5 required
OsFamilyDto
object
Describes a supported OS family for Master Images.
2 properties 2 required
VmSecurityType
string
Security profile for Azure VMs.
DeployFromManagedImageRequest
object
Request to deploy a new Master Image VM from an Azure Managed Image.
17 properties 10 required
DeployFromMarketplaceRequest
object
Request to deploy a new Master Image VM from a curated Azure Marketplace OS image.
17 properties 10 required
DeployFromGalleryResponse
object
Response returned when a Deploy from Gallery operation is initiated. Contains the created Master Image record and the background job tracking info.
2 properties 2 required
MasterImageStatus
string
Lifecycle status of a Foundry-managed Master Image. Tracks the image's current operational state in the management workflow.
MarketplaceImageDto
object
Describes a curated Azure Marketplace OS image available for Master Image deployment.
9 properties 9 required
MasterImageOperationDto
object
Active operation associated with a Master Image.
7 properties 5 required
MasterImageVersionActionAvailabilityDto
object
Server-computed availability of Master Image version actions.
3 properties 3 required
DeployFromMarketplaceResponse
object
Response returned when a Deploy from Marketplace operation is initiated. Contains the created Master Image record and the background job tracking info.
2 properties 2 required
MasterImageDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties 5 required
MasterImageActionType
string
Types of actions that can be performed on a master image.
MasterImageVersionDto
object
Response DTO for a Master Image published version record.
11 properties 10 required
PublishMasterImageResponse
object
Response returned when a Publish operation is initiated. Contains the created Master Image version record and the background job tracking info.
2 properties 2 required
MasterImageVersionOperationStateDto
object
Operation state and action availability for a Master Image version.
2 properties 2 required
MasterImageVersionStatus
string
Lifecycle status for a published Master Image version
MasterImageDecommissionResourceType
string
Azure resource category shown in a Master Image decommission plan.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

controlup-master-images-api-openapi.yml Raw ↑

Other APIs ControlUp publishes across the network.

ControlUp MCP Server
AE Profile APIs.io
ControlUp Alerts API
AE Profile APIs.io
ControlUp Alerts - Devices API
AE Profile APIs.io
ControlUp Applications API
AE Profile APIs.io
ControlUp Audit Log API
AE Profile APIs.io
ControlUp Cloud providers API
AE Profile APIs.io
ControlUp Dal API
AE Profile APIs.io
ControlUp Data API
AE Profile APIs.io
ControlUp Devices API
AE Profile APIs.io
ControlUp Dynamic Query API API
AE Profile APIs.io
ControlUp Events API
AE Profile APIs.io
ControlUp Features API
AE Profile APIs.io
#Master images
← Back to C APIs
API Details
ID
controlup:controlup-master-images-api
Base URL
https://api.controlup.com/v1
Docs
https://api.controlup.io/reference
Provider
ControlUp
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=controlup-master-images-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/controlup-master-images-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Master images 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.