# Workspot APIs API

**Canonical:** https://apis.io/apis/workspot/workspot-apis-api/  
**Provider:** Workspot — https://apis.io/providers/workspot/  
**Base URL:** https://api.workspot.com  
**Documentation:** https://docs.workspot.com/docs/workspot-splunksiem-api-user-guide

Workspot APIs API is one of 2 APIs that [Workspot](https://apis.io/providers/workspot/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Workspot Control REST interface for administrators. See the descriptions below and <a href="https://docs.workspot.com/v1/docs/using-the-workspot-control-api">Using the Workspot Control API </a>for additional information

## Operations (60 of 105)

| Method | Path | Summary |
|---|---|---|
| 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 |

…and 45 more operations. They are listed in full on the page.

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/workspot/refs/heads/main/openapi/workspot-apis-api-openapi.yml
- **Swagger** — https://raw.githubusercontent.com/api-evangelist/workspot/refs/heads/main/openapi/_original/workspot-control-openapi-original.json
- **Documentation** — https://docs.workspot.com/docs/using-the-workspot-control-api
- **APIReference** — https://api.workspot.com/swagger-ui.html
- **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

## Other Workspot APIs (1)

- [Workspot SIEM (Splunk) Events API](https://apis.io/apis/workspot/siem/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/workspot/workspot-apis-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/workspot/.