Workspot

Workspot APIs API

Workspot Control REST interface for administrators. See the descriptions below and Using the Workspot Control API for additional information

GitHub OpenAPI

Operations 105

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… #
GET /v1.0/clouds/rdgateways/vmClasses Returns information about VM Classes required to create gateway cluster… #
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… #
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… #
GET /v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways/{gatewayId}/performance Returns system performance statistics such as CPU and memory usage for a… #
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. #
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 #

Documentation

📖
Documentation
https://docs.workspot.com/docs/using-the-workspot-control-api
📖
APIReference
https://api.workspot.com/swagger-ui.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/workspot/refs/heads/main/openapi/workspot-apis-api-openapi.yml

Other Resources

🔗
Swagger
https://raw.githubusercontent.com/api-evangelist/workspot/refs/heads/main/openapi/_original/workspot-control-openapi-original.json
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/workspot/refs/heads/main/errors/workspot-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/workspot/refs/heads/main/data-model/workspot-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/workspot-apis-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

workspot-apis-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: REST APIs for IT Service Management (ITSM), automation or scripting tools
  version: '1.0'
  title: Workspot Control REST APIs API
  termsOfService: https://www.workspot.com/legal/desktop-service-daas-subscription-agreement/
  contact:
    name: support@workspot.com
servers:
- url: https://api.workspot.com/
tags:


# --- truncated at 32 KB (186 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/workspot/refs/heads/main/openapi/workspot-apis-api-openapi.yml