Workspot Control REST API
REST API for Workspot Control, the SaaS management plane for Workspot Cloud PCs. 105 operations across 85 paths for IT Service Management (ITSM), automation and scripting tools — provisioning and lifecycle of desktop pools and desktops, user and group assignment, template build/clone/publish, cloud application server pools and published applications, RD gateway clusters, cloud/region/zone/network discovery, licenses, stale devices and usage reporting. OAuth 2.0 or Microsoft Entra ID token authentication; many operations are asynchronous and return a StatusURL to poll.
Workspot Control REST API is one of 2 APIs that Workspot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Virtual Desktop Infrastructure, Desktop as a Service, Cloud PC, Provisioning, and Automation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 105 operations across 85 paths, and defines 120 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://api.workspot.com.
105 operations
85 paths
120 schemas
14 DELETE42 GET49 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 105
Across 85 paths, the API surfaces 105 operations — 14 DELETE, 42 GET, 49 POST. Each is listed below with its method, path, parameters, and response codes.
APIs 105
Workspot Control REST interface for administrators. See the descriptions below and Using the Workspot Control API for additional information
GET
/v1.0/bundles
Returns a list of all application bundles
POST
/v1.0/bundles
Creates a new application bundle
GET
/v1.0/bundles/{bundleId}
Returns an application bundle details
POST
/v1.0/bundles/{bundleId}
Updates an existing application bundle
DELETE
/v1.0/bundles/{bundleId}
Deletes an application bundle
GET
/v1.0/cloudAppPools
Returns a list of all application server pools
POST
/v1.0/cloudAppPools
Creates an application server pool
GET
/v1.0/cloudAppPools/applications
Returns a list of all application server applications
POST
/v1.0/cloudAppPools/applications
Creates an application
GET
/v1.0/cloudAppPools/applications/{appId}
Returns application details
POST
/v1.0/cloudAppPools/applications/{appId}
Updates an application
DELETE
/v1.0/cloudAppPools/applications/{appId}
Deletes an application
POST
/v1.0/cloudAppPools/applications/{appId}/icon
Updates an application icon
GET
/v1.0/cloudAppPools/{cloudAppPoolId}
Returns the details about an application server pool
DELETE
/v1.0/cloudAppPools/{cloudAppPoolId}
Deletes an application server pool
GET
/v1.0/cloudAppPools/{cloudAppPoolId}/appServers
Returns a list of application servers in a pool
GET
/v1.0/cloudAppPools/{cloudAppPoolId}/appServers/{appServerId}
Returns details for a single application server
DELETE
/v1.0/cloudAppPools/{cloudAppPoolId}/appServers/{appServerId}
Deletes a Cloud app server
POST
/v1.0/cloudAppPools/{poolId}
Updates an application server pool
GET
/v1.0/clouds
Returns information about public clouds
GET
/v1.0/clouds/rdgateways/images
Returns information Market place images required to create gateway cluster (managed gateways)
GET
/v1.0/clouds/rdgateways/vmClasses
Returns information about VM Classes required to create gateway cluster (managed gateways)
GET
/v1.0/clouds/{subscriptionName}/customImages
Returns information about Custom Images
POST
/v1.0/clouds/{subscriptionName}/customImages
Adds a new Custom Image
GET
/v1.0/clouds/{subscriptionName}/networks
Returns information about Cloud networks
GET
/v1.0/clouds/{subscriptionName}/regions
Returns list of regions
GET
/v1.0/clouds/{subscriptionName}/regions/{region}/networks
Returns information about Cloud networks in a region
GET
/v1.0/clouds/{subscriptionName}/regions/{region}/securityGroups
Returns information AWS security groups
GET
/v1.0/clouds/{subscriptionName}/regions/{region}/zones
Returns list of Zones for provided region
GET
/v1.0/clouds/{subscriptionName}/templates
Returns information about templates
POST
/v1.0/clouds/{subscriptionName}/templates/build
Builds a new template Image
POST
/v1.0/clouds/{subscriptionName}/templates/register
Registers a new template Image
GET
/v1.0/clouds/{subscriptionName}/templates/vmClasses
Returns information about VM Classes required to create Templates
GET
/v1.0/clouds/{subscriptionName}/templates/{templateName}
Returns information about templates
DELETE
/v1.0/clouds/{subscriptionName}/templates/{templateName}
Deletes template from cloud subscription
POST
/v1.0/clouds/{subscriptionName}/templates/{templateName}/clone
Clones a new template from an existing template
POST
/v1.0/clouds/{subscriptionName}/templates/{templateName}/draft
Draft the template
POST
/v1.0/clouds/{subscriptionName}/templates/{templateName}/preview
Preview the template
POST
/v1.0/clouds/{subscriptionName}/templates/{templateName}/publish
Publish the template
POST
/v1.0/desktops/{desktopId}/cancelUpgradeDesktop
Cancels a upgrade desktop operation
POST
/v1.0/desktops/{desktopId}/retainDesktop
Sets the retention period for a desktop on suspension.
POST
/v1.0/desktops/{desktopId}/upgradeDesktop
Upgrades a persistent desktop to the specified pool
GET
/v1.0/globalDesktops
Returns information on available Global Desktop Applications
GET
/v1.0/globalDesktops/{globalDesktopId}
Return details of Global Desktop
POST
/v1.0/globalDesktops/{globalDesktopId}/pools
Assign pools to global desktop application
GET
/v1.0/groups
Returns a list of all groups
POST
/v1.0/groups/{groupId}/bundle
Assigns an application bundle to a user group
GET
/v1.0/groups/{groupId}/globalDesktops
Returns information on global desktops assigned to a group
POST
/v1.0/groups/{groupId}/globalDesktops
Assign a global desktop application to a group
DELETE
/v1.0/groups/{groupId}/globalDesktops/{globalDesktopId}
Unassign a global desktop application from a group
GET
/v1.0/licenses
Returns a list of Workspot licenses for each VM type purchased
GET
/v1.0/operation/{operationId}
Returns status of an asynchronous operation
GET
/v1.0/policies
Get List of Policies
GET
/v1.0/pools
Returns a list of all desktop pools
POST
/v1.0/pools
Creates Desktop Pool
GET
/v1.0/pools/loginOptions
Get login options for desktop pool
GET
/v1.0/pools/{poolId}
Returns the details for a single pool
GET
/v1.0/pools/{poolId}/agentToken
Returns Agent token for the pool
POST
/v1.0/pools/{poolId}/customdesktop
Creates a desktop in custom cloud pool
GET
/v1.0/pools/{poolId}/desktops
Returns a list of desktops in a pool
POST
/v1.0/pools/{poolId}/desktops
Creates a desktop
GET
/v1.0/pools/{poolId}/desktops/{desktopId}
Returns details for a single desktop
DELETE
/v1.0/pools/{poolId}/desktops/{desktopId}
Deletes a desktop
POST
/v1.0/pools/{poolId}/desktops/{desktopId}/attachSnapshot
Attaches a snapshot to a desktop
POST
/v1.0/pools/{poolId}/desktops/{desktopId}/cancelMoveDesktop
Cancels a move desktop operation
POST
/v1.0/pools/{poolId}/desktops/{desktopId}/moveDesktop
Moves a persistent desktop to the specified pool
POST
/v1.0/pools/{poolId}/desktops/{desktopId}/pause
Pauses a desktop
POST
/v1.0/pools/{poolId}/desktops/{desktopId}/reboot
Reboots a desktop
POST
/v1.0/pools/{poolId}/desktops/{desktopId}/redeploy
Redeploys a desktop
POST
/v1.0/pools/{poolId}/desktops/{desktopId}/resume
Resumes a desktop
POST
/v1.0/pools/{poolId}/desktops/{desktopId}/screenshotDesktop
Takes a screen shot of the desktop
POST
/v1.0/pools/{poolId}/desktops/{desktopId}/tags
Sets tags for a desktop
POST
/v1.0/pools/{poolName}
Updates a desktop pool.
GET
/v1.0/rdgateways/authenticationOptions
Returns information about authentication options required to create gateway cluster (managed gateways)
GET
/v1.0/rdgateways/clusters
Returns information about each gateway cluster (managed gateways)
POST
/v1.0/rdgateways/clusters
Creates Gateway Cluster
GET
/v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways
Returns information about each gateway in a given cluster
GET
/v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways/{gatewayId}/connections
Returns information about the Client connections for a gateway in the specified gateway cluster
GET
/v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways/{gatewayId}/performance
Returns system performance statistics such as CPU and memory usage for a gateway in the specified cluster
POST
/v1.0/rdgateways/clusters/{clusterName}
Updates GatewayCluster
DELETE
/v1.0/rdgateways/clusters/{clusterName}
Deletes GatewayCluster
POST
/v1.0/rdgateways/clusters/{clusterName}/gateways
Creates Gateway Host in a cluster
DELETE
/v1.0/rdgateways/clusters/{clusterName}/gateways/{gatewayName}
Deletes Gateway Host from a cluster
POST
/v1.0/rdgateways/clusters/{clusterName}/gateways/{gatewayName}/enable
Enables Gateway Host from a cluster
POST
/v1.0/rdgateways/clusters/{clusterName}/gateways/{gatewayName}/reboot
Reboots Gateway Host from a cluster
POST
/v1.0/rdgateways/clusters/{clusterName}/publish
Publish GatewayCluster
POST
/v1.0/reports/generateusagereport
Generates a report of active users
GET
/v1.0/reports/users
Generates a report of all users and their resource assignments
GET
/v1.0/staleDevices
Returns all stale devices. For specific dates or page number use this signature [/v1.0/staleDevices?startDate=2024-09-08&endDate=2024-09-15&pageNumber=5]
DELETE
/v1.0/staleDevices
Deletes given list of stale devices from Control.
POST
/v1.0/users
Creates a user
GET
/v1.0/users/{email}/
Returns user details
DELETE
/v1.0/users/{email}/
Deletes a user
POST
/v1.0/users/{email}/assignCostCenter
Assigns a cost center to a user
POST
/v1.0/users/{email}/desktops
Assigns a desktop to a user
DELETE
/v1.0/users/{email}/desktops/{desktopId}
Unassigns a desktop from user
DELETE
/v1.0/users/{email}/globalDesktops/{globalApplicationId}
Unassign Global Desktop Application from a user
GET
/v1.0/users/{email}/globalDesktops/{globalDesktopId}
Returns Global Desktop Application details for a user
POST
/v1.0/users/{email}/globalDesktops/{globalDesktopId}/pools
Assign pools to user’s global desktop application
DELETE
/v1.0/users/{email}/globalDesktops/{globalDesktopId}/pools
Deallocate the pools from user’s global desktop application
POST
/v1.0/users/{email}/logoff
Signs a user out of a desktop session
POST
/v1.0/users/{email}/pools
Assigns a user to a given pool
POST
/v1.0/users/{email}/refreshGroupEntitlements
Refreshes group entitlements for given user
POST
/v1.0/users/{email}/remoteAssistanceInvitation
Invites a user to a remote assistance session
POST
/v1.0/users/{email}/sendMessage
Sends a message to a user's desktop
Schemas 120
The contract defines 120 schemas that model the data the API accepts and returns. The most detailed are CreateDesktopPoolRequest (27 properties), UpdateDesktopPoolRequest (21 properties), DesktopPoolDetails (21 properties), GWClusterHostDetails (20 properties). Each schema is shown below with its type and property counts.
APIGetTemplatesResponseBO
object
1 property
APIMasterTemplateBO
object
16 properties
AddCustomImageRequest
object
3 properties
AddUser
object
4 properties
ApiBuildTemplateRequest
object
11 properties
ApiCloneTemplateRequest
object
6 properties
ApiCloudNetworksListResponse
object
1 property
ApiCloudNetworksResponseBO
object
6 properties
ApiCloudRegionBO
object
2 properties
ApiCreateBundleResponse
object
2 properties
ApiCreateCloudAppPoolResponse
object
2 properties
ApiCreateCloudAppResponse
object
2 properties
ApiCustomDesktopCreateResponse
object
2 properties
ApiStatusResponse
object
3 properties
ApplicationDetails
object
14 properties
Applications
object
1 property
AssignBundle
object
1 property
AssignedDesktopBO
object
4 properties
AssignedPoolDesktopDetailsBO
object
4 properties
AsyncOperationStatus
object
1 property
AttachSnapshot
object
5 properties
1 required
AuthenticationOptions
object
3 properties
BundleDetails
object
4 properties
BundlesDTO
object
1 property
CloudAppPool
object
1 property
CloudAppPoolDetails
object
10 properties
CloudAppServerDetails
object
7 properties
CloudAppServers
object
1 property
CloudConfigSubscriptions
object
1 property
CloudDetails
object
5 properties
CloudImages
object
1 property
Clusters
object
1 property
Cost Center to Assign
object
1 property
CreateBundleRequestDTO
object
2 properties
CreateCloudAppPool
object
9 properties
CreateCloudAppRequest
object
15 properties
CreateCustomDesktop
object
4 properties
CreateDesktop
object
6 properties
CreateDesktopPoolRequest
object
27 properties
CreateDesktopPoolResponse
object
4 properties
CustomDesktopDTO
object
4 properties
CustomImageResponse
object
1 property
DeleteStaleDeviceRequest
object
1 property
Desktop
object
9 properties
Desktop to Assign
object
1 property
DesktopList
object
1 property
DesktopPoolDetails
object
21 properties
ErrorInfo
object
2 properties
GWAddGwHost
object
2 properties
GWClusterActionResponse
object
3 properties
GWClusterDetails
object
11 properties
GWClusterHostConnectionDetails
object
3 properties
GWClusterHostDetails
object
20 properties
GWClusterHostPerformanceDetails
object
2 properties
GWClusterHostPerformanceSample
object
2 properties
GWClusterHostSessionDetails
object
8 properties
GWCreateCluster
object
19 properties
GWDomainToJoin
object
5 properties
GWDomainToJoinBO
object
5 properties
GWHostLocalAdmin
object
2 properties
GWPool
object
5 properties
GWRegionalClusterDetails
object
9 properties
GWUpdateCluster
object
4 properties
GWUpdateClusterResponse
object
3 properties
GetLoginOptionsResponse
object
1 property
GetPoliciesResponse
object
2 properties
GlobalDesktopBO
object
4 properties
GlobalDesktopDetailsBO
object
2 properties
GlobalDesktopId
object
1 property
GlobalDesktopListBO
object
1 property
GlobalDesktopPool
object
4 properties
GlobalDesktopPoolsList
object
3 properties
GlobalDesktopsList
object
3 properties
GroupDetailBO
object
3 properties
GroupsList
object
1 property
Hosts
object
1 property
HydrateDuration
object
1 property
Images
object
1 property
KeyValuePairBO
object
2 properties
License
object
1 property
LicenseDetails
object
14 properties
MoveDesktopRequest
object
2 properties
2 required
NameResponse
object
1 property
NpsServerBO
object
3 properties
OpResponse
object
5 properties
Pool
object
1 property
Pool to Assign
object
1 property
Pool to Delete from GlobalDesktop
object
1 property
PoolAgentTokenDetails
object
2 properties
PoolPrecedenceDetails
object
2 properties
RefreshEntitlementsResponse
object
1 property
Regions
object
1 property
RegisterTemplateRequestBO
object
2 properties
RemoteAssistDesktop
object
3 properties
3 required
RemoteSessionDesktop
object
2 properties
2 required
RemoteSessionDesktopMessage
object
4 properties
4 required
SecurityGroup
object
3 properties
SecurityGroups
object
1 property
StaleDevice
object
11 properties
StaleDevices
object
4 properties
Tag
object
2 properties
TagDesktopRequest
object
3 properties
TemplateCustomImageBO
object
3 properties
TemplateVMClass
object
6 properties
TemplateVmClasses
object
1 property
UpdateCloudAppPool
object
5 properties
UpdateCloudAppRequest
object
12 properties
UpdateDesktopPoolRequest
object
21 properties
UpgradeDesktopRequest
object
7 properties
6 required
UsageReport
object
3 properties
User
object
7 properties
UserDesktop
object
3 properties
UserGlobalDesktopPoolDetailsBO
object
7 properties
UserPool
object
7 properties
VDIPoolDetails
object
1 property
VMClass
object
2 properties
VMRetentionDetails
object
3 properties
VMRetentionPeriod
object
1 property
VmClasses
object
1 property
Zones
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Workspot 1
Other APIs Workspot publishes across the network.
Workspot SIEM (Splunk) Events API
#Virtual Desktop Infrastructure#Desktop as a Service#Cloud PC#Provisioning#Automation
Where this information came from
This is an independent, third-party profile of Workspot Control REST 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.