ControlUp Subscriptions API
The Subscriptions API from ControlUp — 27 operation(s) for subscriptions.
ControlUp Subscriptions API is one of 61 APIs that ControlUp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 31 operations across 27 paths, and defines 58 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.
31 operations
27 paths
58 schemas
1 DELETE22 GET1 PATCH6 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
ControlUp Subscriptions 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 31
Across 27 paths, the API surfaces 31 operations — 1 DELETE, 22 GET, 1 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Subscriptions 31
POST
/cloud/subscriptions/{id}/credentials/verifydeprecated
Verify subscription credentials (Deprecated)
POST
/cloud/subscriptions/{id}/credentials/verify/transcriptdeprecated
Verify subscription credentials - transcript (Deprecated)
GET
/cloud/subscriptions/{id}/credentials/verify/streamdeprecated
Verify subscription credentials - streaming (Deprecated)
POST
/cloud/subscriptions/{id}/credentials/verify/ssedeprecated
Verify subscription credentials - streaming (Deprecated)
GET
/cloud/subscriptions/{subscriptionId}/metadata/regions
Get available regions for a subscription
GET
/cloud/subscriptions/{subscriptionId}/metadata/regions/{region}
Get region metadata
GET
/cloud/subscriptions/{subscriptionId}/metadata/vm-sizes
Get available VM sizes for a region with filtering, sorting, and pagination support
GET
/cloud/subscriptions/{subscriptionId}/metadata/os-disks
Get available OS disk size options for a region
GET
/cloud/subscriptions/{subscriptionId}/metadata/compute-quota
Get compute quota usage for a region
GET
/cloud/subscriptions/{subscriptionId}/preflight/permissions/host-pool-create
Check host pool create permissions
GET
/cloud/subscriptions/{subscriptionId}/preflight/permissions/session-host-create
Check session host create permissions
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/virtual-networks
Lookup virtual networks in a subscription
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/virtual-machines
Lookup virtual machines in a subscription
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/galleries
Lookup Azure Compute Galleries in a subscription
GET
/cloud/subscriptions/{subscriptionId}/lookup/resource-groups
Lookup Azure resource groups in a subscription
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/workspaces
Lookup AVD workspaces in a subscription
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/managed-images
Lookup Azure Managed Images in a subscription
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/gallery-images
Lookup gallery images in a subscription
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/gallery-image-versions
Lookup gallery image versions in a subscription
GET
/cloud/subscriptions/{id}/resources/discoverdeprecated
Discover resources in a subscription (Deprecated)
GET
/cloud/subscriptions/{id}/resources/discover/hostpoolsdeprecated
Discover host pools in a subscription (Deprecated)
GET
/cloud/subscriptions/{id}/resources/discover/imagesdeprecated
Discover images in a subscription (Deprecated)
POST
/cloud/subscriptions/{id}/resources/importdeprecated
Import cloud resources (Deprecated)
GET
/cloud/subscriptions
Get subscriptions
POST
/cloud/subscriptionsdeprecated
Create a subscription (Deprecated)
GET
/cloud/subscriptions/{id}
Get a subscription by ID
PUT
/cloud/subscriptions/{id}deprecated
Update a subscription (Deprecated)
PATCH
/cloud/subscriptions/{id}deprecated
Rotate subscription credentials (Deprecated)
DELETE
/cloud/subscriptions/{id}deprecated
Delete a subscription (Deprecated)
GET
/cloud/subscriptions/{id}/statusdeprecated
Get subscription status (Deprecated)
POST
/cloud/subscriptions/{id}/status/refreshdeprecated
Refresh subscription status (Deprecated)
Schemas 58
The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are LookedUpManagedImageDto (26 properties), LookedUpImageDto (26 properties), VmSizeDto (25 properties), DiscoveredImageDto (25 properties). Each schema is shown below with its type and property counts.
VerificationStepResponse
object
Response DTO representing a single verification step result. Each step contains information about a specific check performed during credential verification.
5 properties
4 required
LookedUpResourceGroupDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
CloudSubscriptionDto
object
Response DTO representing a cloud subscription (Azure Subscription, AWS Account, GCP Project).
11 properties
10 required
LookedUpManagedImageDto
object
Represents a looked-up Azure Managed Image (Microsoft.Compute/images) for the managed image picker. Extends the base image DTO with managed-image-specific prop…
26 properties
10 required
ComputeQuotaDto
object
Represents a compute quota usage entry for a subscription region. Includes vCPU family quotas, total regional vCPU quota, and other compute resource quotas (e.…
4 properties
4 required
ImportCloudResourcesRequest
object
Request model for importing cloud resources. Supports two modes: 1. Import ALL resources of ALL types (importAll = true) 2. Import specific resources by type (…
2 properties
LookedUpVirtualMachineDto
object
Represents a looked-up virtual machine resource with promoted VM-specific properties.
12 properties
12 required
DiscoveredCloudResourceDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
VmSizeDto
object
Data transfer object representing a virtual machine size/SKU. Contains specifications and capabilities for capacity planning and provisioning.
25 properties
17 required
SubscriptionLifecycleState
string
Lifecycle state of a cloud subscription. Represents the subscription's position in the wizard/management workflow.
ImageSourceType
string
Represents the source type of a virtual machine image.
LookedUpGalleryImageVersionDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 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
LookedUpGalleryDto
object
Represents a looked-up Azure Compute Gallery resource.
7 properties
7 required
VerificationStatus
string
Represents the status of a verification check (credentials, inventory sync, etc.).
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.
VerificationStepStatus
string
Discrete states a verification step can finish in.
PermissionCheckStatus
string
Outcome of an advisory permission pre-flight check. The check never blocks an operation; consumers decide how to surface each status.
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
CloudSubscriptionStatusDto
object
Complete status information for a cloud subscription. Used when querying subscription status directly (e.g., GET /subscriptions/{id}/status). Provides overall…
10 properties
3 required
DiscoveredHostPoolDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
SubscriptionHealthStatus
string
Operational health status of an active cloud subscription. Only meaningful when SubscriptionLifecycleState = Active. Derived from last verification and invento…
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
ComputeQuotaDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
DiscoveredCloudResourceDto
object
Represents a discovered cloud resource that belongs to a resource group.
8 properties
8 required
LookedUpImageDto
object
Represents a looked-up image resource.
26 properties
11 required
LookedUpGalleryDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
RegionMetadataDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
DiscoveredHostPoolDto
object
Represents a discovered Azure Virtual Desktop host pool. Extends the base CloudResourceDto with host pool-specific properties.
9 properties
9 required
LookedUpVirtualMachineDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
CloudResourceIdsByTypeDto
object
Represents a collection of resource IDs for a specific resource type.
2 properties
2 required
VmSecurityType
string
Security profile for Azure VMs.
LookedUpImageDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
DiskSizeDto
object
A flat OS disk size option row for VM-size catalog responses.
7 properties
4 required
CloudPermissionCapabilityGroup
string
Logical grouping of RBAC actions checked by the permission pre-flight, so clients can render semantically meaningful warnings per capability instead of parsing…
VmSizeDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
CloudProviderAuthType
string
Specifies the supported authentication types for connecting to various cloud providers and services.
DiscoverableResourceType
string
Public API enum for resource types that users can discover/import. Only includes high-level resource types exposed to end users.
HostPoolType
string
Represents the type of Azure Virtual Desktop host pool.
PatchCloudSubscriptionRequest
object
Request model for partial update of an existing subscription.
2 properties
DiskSizeDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
LookedUpWorkspaceDto
object
Represents a looked-up Azure Virtual Desktop workspace.
8 properties
8 required
VerificationTranscriptResponse
object
Generic response for operations that produce formatted line-by-line output. Can be used for validations, diagnostics, migrations, deployments, or any operation…
2 properties
2 required
VerificationResponse
object
Response containing detailed results of a credential verification operation. Includes overall success status, individual step results, and timing information.
5 properties
4 required
LookedUpWorkspaceDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
DiscoveredImageDto
object
Represents a discovered virtual machine image. Extends the base CloudResourceDto with image-specific properties.
25 properties
10 required
LookedUpManagedImageDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
RegionMetadataDto
object
Region metadata for a subscription.
7 properties
3 required
LookedUpVirtualNetworkDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
LookedUpGalleryImageVersionDto
object
Represents a looked-up gallery image version resource.
15 properties
8 required
PermissionPreflightResultDto
object
Result of an advisory service principal permission pre-flight check. Advisory-only: a missingPermissions status must never block the operation, and unknown (th…
3 properties
2 required
CreateCloudSubscriptionRequest
object
Request model for creating a new subscription.
5 properties
5 required
UpdateCloudSubscriptionRequest
object
Request model for updating an existing subscription.
5 properties
5 required
MissingPermissionDto
object
A required RBAC action the service principal is missing, together with the ARM scope it was evaluated at. Each entry is a complete remediation statement: grant…
3 properties
3 required
DiscoveredImageDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
CloudProvider
string
Enumeration of supported cloud provider identifiers.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ControlUp 12
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
#Subscription
Where this information came from
This is an independent, third-party profile of ControlUp Subscriptions 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.