ControlUp Tenants API is one of 61 APIs that ControlUp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Tenants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
31 operations
across 23 paths,
and defines 42 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.
The identity and technical contract details declared by the specification.
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
UpdateCloudCredentialRequest
object
Request model for updating a cloud credential.
2 properties
2 required
DiscoveredManagedCloudResourceDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
PatchCloudCredentialRequest
object
Request model for patching (partial update) a cloud credential. All fields are optional - only provided fields will be updated.
2 properties
DiscoveredImageDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
CloudCredentialDto
object
Response DTO representing a cloud credential (Service Principal, IAM User/Role, etc.).
10 properties
8 required
TenantHealthStatus
string
Aggregated health status for a cloud tenant. Computed from subscription health statuses and credential verification results.
TenantSubscriptionImportDto
object
Represents a subscription and its resources to import.
2 properties
2 required
ImageSourceType
string
Represents the source type of a virtual machine image.
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
VerificationStatus
string
Represents the status of a verification check (credentials, inventory sync, etc.).
DiscoveredSubscriptionDto
object
Represents a subscription discovered from a cloud tenant.
8 properties
8 required
CreateCloudCredentialRequest
object
Request model for creating a new cloud credential.
2 properties
2 required
VerificationStepStatus
string
Discrete states a verification step can finish in.
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
DiscoveredManagedCloudResourceDto
object
Represents a discovered cloud resource with managed status. Used by the generic multi-type discover endpoint where resources may be already imported.
9 properties
9 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…
ResourceImportMode
string
Defines how a resource import treats managed resources omitted from the import request.
ImportTenantResourcesRequest
object
Request model for importing cloud resources at the tenant level. Supports two modes: 1. Import ALL resources from ALL subscriptions under the tenant (importAll…
3 properties
DiscoveredSubscriptionDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties
5 required
UpdateCloudTenantRequest
object
Request model for updating a cloud tenant. Allows updating tenant name and optionally replacing the default credential.
2 properties
1 required
DiscoveredHostPoolDto
object
Represents a discovered Azure Virtual Desktop host pool. Extends the base CloudResourceDto with host pool-specific properties.
9 properties
9 required
CreateCloudTenantRequest
object
Request model for creating a new cloud tenant with its default credential. The default credential is created as a separate entity linked to the tenant.
4 properties
4 required
CloudResourceIdsByTypeDto
object
Represents a collection of resource IDs for a specific resource type.
2 properties
2 required
CloudTenantDto
object
Response DTO representing a cloud tenant (Azure AD Tenant, AWS Organization, GCP Organization).
12 properties
10 required
VmSecurityType
string
Security profile for Azure VMs.
CloudProviderAuthType
string
Specifies the supported authentication types for connecting to various cloud providers and services.
TenantSubscriptionStatusDto
object
Subscription status details within a tenant status response. Includes subscription identity and full status information.
13 properties
5 required
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.
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
CredentialStatus
string
Status of an individual credential. Used for rate limiting, health tracking, and administrative state.
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
CloudTenantStatusDto
object
Status information for a cloud tenant. Used when querying tenant status directly (e.g., GET /tenants/{id}/status). Provides aggregated health status computed f…
5 properties
1 required
DiscoveredImageDto
object
Represents a discovered virtual machine image. Extends the base CloudResourceDto with image-specific properties.
25 properties
10 required
TenantDefaultCredentialDto
object
Simplified response DTO for a tenant's default credential (nested within CloudTenantDto). Contains only authentication type and masked credentials. For full cr…
2 properties
2 required
TenantLifecycleState
string
Lifecycle state of a cloud tenant. Represents the tenant's position in the management workflow.
CredentialStatusDto
object
Response DTO representing the pool status of a credential. Includes health status, cooldown state, and usage metrics from Redis.
13 properties
9 required
PatchCloudTenantRequest
object
Request model for patching (partial update) a cloud tenant. All fields are optional - only provided fields will be updated.
2 properties
CloudProvider
string
Enumeration of supported cloud provider identifiers.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ControlUp publishes across the network.
