Jump to Content
API Reference
Changelog
API Reference
API Reference
Changelog
Create and Manage API Keys
All
Pages
Start typing to search…
JUMP TO
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 organization
post
Users
List all users
get
Retrieve a user
get
Update a user
patch
Delete a user
del
Revoke a user’s API keys
post
Invitations
Invite users
post
Resend invitation
patch
Roles
List all roles
get
Create a role
post
Retrieve a role
get
Update a role
patch
Delete a role
del
SAML
Get SAML configuration
get
Create SAML settings
post
Update SAML settings
patch
Create SAML settings from IdP integration
post
Organization Settings
Retrieve organization settings
get
Update organization settings
patch
IP Allowlist
List all IP allowlist entries
get
Create an IP allowlist entry
post
Update an IP allowlist entry
patch
Delete an IP allowlist entry
del
Audit Log
Get audit log
get
SSO Groups
List all SSO groups
get
Create an SSO group
post
Update an SSO Group
patch
Delete an SSO group
del
Alerts
List all Alerts
get
Alerts - Devices
Retrieve a Devices Alert
get
Update a Devices alert
patch
Delete a Devices alert
del
Create a Devices alert
post
License Usage
Retrieve license usage in time range
get
Desktops
How to Use the ControlUp for Desktops API
Alerts
List all Alerts
get
Create an Alert
post
Retrieve Alert
get
Edit alert
post
Delete alert
del
Dal
Get scoped data index
post
Data
List all data indices
get
Create a data index
post
Get a data index
get
Get data index mappings
get
Retrieve a document
get
List all custom reports
get
Get a custom report
get
Devices
List all devices
get
Delete devices
post
List all device tags
get
Update device tags
post
List all device groups
get
Set device group
post
Perform action on a single device
post
Perform action on multiple devices
post
Scripts
List all scripts
get
Surveys
List all surveys
get
Publish a survey
post
Get a survey
get
Delete a survey
del
Pause a survey
post
Resume a survey
post
Complete a survey
post
Get survey results
get
Get survey answers
get
Events
Get system events
get
Get system events with query
post
VDI & DAAS Reports
User
Get user activity status
get
Host
Get host metrics per folder
get
Get host counts
get
Machine
Get machine statistics
get
Get sizing recommendations for virtual environments
get
Get sizing recommendation for machine for Azure environment
get
Support endpoint
Start upload date
get
NetScaler
Get NetScaler metrics with time series
get
Get Load Balancer metrics with time series
get
Get Gateway metrics with time series
get
Get NetScaler metrics
get
Get Load Balancer metrics
get
Get Gateway metrics
get
Session
Get session statistics
get
Get individual session details
get
Get session timeline
get
Applications
Get usage details for an application
get
Get usage details for all applications
get
Get application statistics
get
VDI & DaaS Configuration
Machines
List machines
get
Get machine details
get
Create or update machines
post
Delete machines
del
Compliance
Devices
List all devices
get
Get device details
get
List device vulnerabilities
get
List device patches
get
List device compliance issues
get
List device misconfigurations
get
Synthetic Monitoring
Alerts
List all alerts
get
List Scout IDs with alerts
get
List alerts for a Scout
get
List alert policies for a Scout
get
Get alert policy details
get
Create alert policy
post
Update alert policy
patch
Delete alert policy
del
List all integrations
get
Scouts
List all Scouts
get
Create a Scout
post
Get Scout info
get
Edit Scout
put
Delete Scout
del
Enable/disable Scout
post
Tests
List tests
get
Hives
List all Custom Hives
get
List all Cloud Hives
get
MFAs
List all MFA users
get
dex events
Events
List all Events
post
Get total count of events
get
Retrieve an event
get
Powered by
Create and Manage API Keys
Ask AI
