For AI agents: visit https://api.controlup.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
ControlUp API
API ReferenceChangelog
ControlUp API
API Reference
API ReferenceChangelog

Using ControlUp APIs

  • Create and Manage API Keys
  • Rate Limiting
  • VDI & DaaS PowerShell Cmdlets

Platform

  • How to Make API Requests
  • Filtering API Results
  • Organizations
    • Create a tenant organizationpost
    • Copy Desktops datapost
    • List all tenantsget
  • Tags
    • List all tagsget
    • Retrieve a tagget
    • Create a tagpost
    • Update a tagpatch
    • Delete a tagdel
  • Users
    • List all usersget
    • Retrieve a userget
    • Update a userpatch
    • Delete a userdel
    • Revoke a user’s API keyspost
  • Invitations
    • Invite userspost
    • Resend invitationpatch
  • Roles
    • List all rolesget
    • Create a rolepost
    • Retrieve a roleget
    • Update a rolepatch
    • Delete a roledel
  • Organization Settings
    • Retrieve organization settingsget
    • Update organization settingspatch
  • SAML
    • Get SAML configurationget
    • Create SAML settingspost
    • Update SAML settingspatch
    • Create SAML settings from IdP integrationpost
  • IP Allowlist
    • List all IP allowlist entriesget
    • Create an IP allowlist entrypost
    • Update an IP allowlist entrypatch
    • Delete an IP allowlist entrydel
  • Audit Log
    • Get audit logget
  • SSO Groups
    • List all SSO groupsget
    • Create an SSO grouppost
    • Update an SSO Grouppatch
    • Delete an SSO groupdel
  • Events
    • List all Eventspost
    • Get total count of eventsget
    • Retrieve an eventget
  • Alerts
    • List all Alertsget
  • Alerts - Devices
    • Retrieve a Devices Alertget
    • Update a Devices alertpatch
    • Delete a Devices alertdel
    • Create a Devices alertpost
  • License Usage
    • Retrieve license usage in time rangeget

Desktops

  • How to Use the ControlUp for Desktops API
  • Dal
    • Get scoped data indexpost
  • Data
    • List all data indicesget
    • Create a data indexpost
    • Get a data indexget
    • Get data index mappingsget
    • Retrieve a documentget
    • List all custom reportsget
    • Get a custom reportget
  • Alerts
    • List all Alertsget
    • Create an Alertpost
    • Retrieve Alertget
    • Edit alertpost
    • Delete alertdel
  • Devices
    • List all devicesget
    • Delete devicespost
    • List all device tagsget
    • Update device tagspost
    • List all device groupsget
    • Set device grouppost
    • Perform action on a single devicepost
    • Perform action on multiple devicespost
  • Events
    • Get system eventsget
    • Get system events with querypost
  • Scripts
    • List all scriptsget
  • Surveys
    • List all surveysget
    • Publish a surveypost
    • Get a surveyget
    • Delete a surveydel
    • Pause a surveypost
    • Resume a surveypost
    • Complete a surveypost
    • Get survey resultsget
    • Get survey answersget

VDI & DAAS API

  • Host
    • Get host metrics per folderget
    • Get host countsget
  • User
    • Get user activity statusget
  • WindowsEvents
    • Get Windows Eventsget
  • Machine
    • Get machine statisticsget
    • Get sizing recommendations for virtual environmentsget
    • Get sizing recommendation for machine for Azure environmentget
    • Get aggregated machine statisticsget
  • NetScaler
    • Get NetScaler metrics with time seriesget
    • Get Load Balancer metrics with time seriesget
    • Get Gateway metrics with time seriesget
    • Get NetScaler metricsget
    • Get Load Balancer metricsget
    • Get Gateway metricsget
  • Support endpoint
    • Start upload dateget
  • Processes
    • Get usage details for a processget
    • Get usage details for all processesget
  • Session
    • Get session statisticsget
    • Get individual session detailsget
    • Get session timelineget
    • Get aggregated session activityget
  • Applications
    • Get usage details for an applicationget
    • Get usage details for all applicationsget
    • Get application statisticsget

VDI & DaaS Configuration API

  • Machines
    • List machinesget
    • Get machine detailsget
    • Create or update machinespost
    • Delete machinesdel
  • Triggers
    • List triggers for the authenticated organization.get
    • Get full details for a single trigger.get
  • TriggerSchedules
    • List trigger schedulesget
    • Get trigger schedule by IDget

VDI & DaaS Realtime

  • Metrics
    • Get Tablesget
    • Get Table Fieldsget
    • Query metricspost

Compliance

  • Devices
    • List all devicesget
    • Get device detailsget
    • List device vulnerabilitiesget
    • List device patchesget
    • List device compliance issuesget
    • List device misconfigurationsget

Synthetic Monitoring

  • Alerts
    • List all alertsget
    • List Scout IDs with alertsget
    • List alerts for a Scoutget
    • List alert policies for a Scoutget
    • Get alert policy detailsget
    • Create alert policypost
    • Update alert policypatch
    • Delete alert policydel
    • List all integrationsget
  • Scouts
    • List all Scoutsget
    • Create a Scoutpost
    • Get Scout infoget
    • Edit Scoutput
    • Delete Scoutdel
    • Enable/disable Scoutpost
  • Tests
    • List testsget
  • Hives
    • List all Custom Hivesget
    • List all Cloud Hivesget
  • MFAs
    • List all MFA usersget

Workflows

  • Flows
    • Get Flowsget
    • Get Flowget
    • Get Flow Runs Statusget
    • Enable/Disable Flowpatch
    • Delete Flowdel
  • Forms
    • Get Formsget
    • Get Formget
    • Delete Formdel
  • Integrations
    • Get Integrationsget
    • Get Integrationget
    • Delete Integrationdel

DaaS IQ API

  • Audit log
    • Trigger a test audit log eventpost
  • Cloud providers
    • Get supported cloud providersget
    • Get supported authentication typesget
    • Get authentication types for a providerget
  • Features
    • Get all featuresget
    • Get a feature statusget
  • Host pool cost
    • Get host pool cost breakdown and trendget
    • Get host pool autoscale savingsget
    • Get per-host cost breakdownget
    • Export host pool cost data as CSVget
  • Host pool deployments
    • Create host pool deploymentpost
  • Host pools
    • Get host poolsget
    • Get host pool statisticsget
    • Get a host pool by IDget
    • Delete host pooldel
    • Get host pool extended detailsget
    • Get host pool metricsget
    • Get session hosts for a host poolget
    • Get user sessions for a host poolget
    • Delete host pool from Azurepost
    • Get VM settings for a host poolget
    • Create or replace VM settings for a host poolput
    • Delete VM settings for a host pooldel
    • Validate VM settings for a host poolpost
    • Get scaling policy for a host poolget
    • Save scaling policy for a host poolput
    • Delete scaling policy for a host pooldel
    • Get active scaling profile for a host poolget
  • Jobs
    • Get a job by IDget
    • Get job parametersget
    • Get jobsget
    • Get job statusget
    • Cancel a jobpost
    • Retry a failed jobpost
    • Get job logsget
    • Get job logs transcriptget
  • License
    • Get license informationget
  • Master images
    • Execute an action on a master imagepost
    • Download an RDP file for a master imageget
    • Get supported OS families for Master Imagesget
    • Get curated Marketplace images for deploymentget
    • List Master Imagesget
    • Get Master Image by IDget
    • Get Master Image operation stateget
    • Get decommission planget
    • Promote existing VM as Master Imagepost
    • Deploy Master Image from Gallery image versionpost
    • Deploy Master Image from curated Marketplacepost
    • Deploy Master Image from Managed Imagepost
    • Delete Master Imagedel
    • Publish Master Image versionpost
    • List Master Image versionsget
    • Get Master Image version operation stateget
    • Get publish artifact cleanup planget
    • Delete Master Image versiondel
    • Delete publish artifactsdel
    • Retry failed Master Image version publishpost
  • Onboarding
    • List onboarding flowsget
    • Get onboarding flowget
    • Update onboarding flowpatch
    • Start onboarding flowpost
    • Update onboarding stepput
    • Dismiss onboarding flowpost
  • Overview
    • Get overview graph dataget
    • Get overview subscriptionsget
    • Get overview regionsget
    • Get overview resource groupsget
    • Get overview host poolsget
    • Get overview session hostsget
    • Get overview imagesget
    • Get overview master imagesget
    • Get overview user sessionsget
    • Get overview application groupsget
    • Get overview workspacesget
  • Scaling profiles
    • Get scaling profilesget
    • Create a scaling profilepost
    • Get a scaling profile by IDget
    • Update a scaling profileput
    • Delete a scaling profiledel
    • Update scaling profile colorpatch
  • Session host deployments
    • Create session hostspost
  • Session hosts
    • Execute an action on a session hostpost
    • Get user sessions for a session hostget
  • Subscriptions
    • Verify subscription credentials (Deprecated)post
    • Verify subscription credentials - transcript (Deprecated)post
    • Verify subscription credentials - streaming (Deprecated)get
    • Verify subscription credentials - streaming (Deprecated)post
    • Get available regions for a subscriptionget
    • Get region metadataget
    • Get available VM sizes for a region with filtering, sorting, and pagination supportget
    • Get available OS disk size options for a regionget
    • Get compute quota usage for a regionget
    • Check host pool create permissionsget
    • Check session host create permissionsget
    • Lookup virtual networks in a subscriptionget
    • Lookup virtual machines in a subscriptionget
    • Lookup Azure Compute Galleries in a subscriptionget
    • Lookup Azure resource groups in a subscriptionget
    • Lookup AVD workspaces in a subscriptionget
    • Lookup Azure Managed Images in a subscriptionget
    • Lookup gallery images in a subscriptionget
    • Lookup gallery image versions in a subscriptionget
    • Discover resources in a subscription (Deprecated)get
    • Discover host pools in a subscription (Deprecated)get
    • Discover images in a subscription (Deprecated)get
    • Import cloud resources (Deprecated)post
    • Get subscriptionsget
    • Create a subscription (Deprecated)post
    • Get a subscription by IDget
    • Update a subscription (Deprecated)put
    • Rotate subscription credentials (Deprecated)patch
    • Delete a subscription (Deprecated)del
    • Get subscription status (Deprecated)get
    • Refresh subscription status (Deprecated)post
  • Tenants
    • Get tenant credentialsget
    • Add a credentialpost
    • Get a credential by IDget
    • Update a credentialput
    • Patch a credentialpatch
    • Delete a credentialdel
    • Enable a credentialpost
    • Disable a credentialpost
    • Get credentials statusget
    • Get credential statusget
    • Verify default credentialspost
    • Verify a credential by IDpost
    • Verify default credentials (transcript)post
    • Verify a credential by ID (transcript)post
    • Verify default credentials - streaming (Deprecated)get
    • Verify a credential by ID - streaming (Deprecated)get
    • Verify default credentials - streamingpost
    • Verify a credential by ID - streamingpost
    • Discover subscriptions accessible by tenant's default credentialsget
    • Discover resources across subscriptions in a tenantget
    • Discover host pools across all subscriptions in a tenantget
    • Discover images across all subscriptions in a tenant (Deprecated)get
    • Import cloud resources for a tenantpost
    • Get tenantsget
    • Create a new tenant with default credentialpost
    • Get a tenant by IDget
    • Update an existing tenantput
    • Partially update a tenantpatch
    • Delete a tenantdel
    • Get tenant statusget
    • Refresh tenant statuspost
  • User sessions
    • Execute an action on a user sessionpost
  • Users
    • Get current user informationget
  • Health
    • Get health statusget
    • Get liveness statusget
    • Get build infoget
Powered by 

VDI & DaaS PowerShell Cmdlets

ControlUp for VDI & DaaS includes the ability to use PowerShell cmdlets to interact with the product. Currently you can use the cmdlets for the following:

Monitor Management

Credentials Management

Actions

Trigger Management

Updated 11 months ago


Rate Limiting
How to Make API Requests
Did this page help you?

Updated 11 months ago


Rate Limiting
How to Make API Requests
Did this page help you?