{"swagger":"2.0","info":{"description":"REST APIs for IT Service Management (ITSM), automation or scripting tools","version":"1.0","title":"Workspot Control REST API","termsOfService":"https://www.workspot.com/legal/desktop-service-daas-subscription-agreement/","contact":{"name":"support@workspot.com"}},"host":"api.workspot.com","basePath":"/","tags":[{"name":"APIs","description":"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"}],"paths":{"/v1.0/bundles":{"get":{"tags":["APIs"],"summary":"Returns a list of all application bundles","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns a list of all application bundles along with their associated apps and groups. This is a synchronous command.","operationId":"bundlesUsingGET","produces":["application/json"],"responses":{"200":{"description":"List of application bundles","schema":{"$ref":"#/definitions/BundlesDTO"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Creates a new application bundle","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Creates a new application bundle with a name and a list of associated applications.","operationId":"createBundleUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Bundle information.","required":true,"schema":{"$ref":"#/definitions/CreateBundleRequestDTO"}}],"responses":{"200":{"description":"Success. Bundle created Successfully.","schema":{"$ref":"#/definitions/ApiCreateBundleResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/bundles/{bundleId}":{"get":{"tags":["APIs"],"summary":"Returns an application bundle details","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns an application bundle along with their associated apps and groups. This is a synchronous command.","operationId":"bundleInfoUsingGET","produces":["application/json"],"parameters":[{"name":"bundleId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string of the bundle. This is obtained through the GET /v1.0/bundles command.","required":true,"type":"string","x-example":"f81eed06-c7a0-46b1-a3bf-50cc8880310b"}],"responses":{"200":{"description":"Application bundle details","schema":{"$ref":"#/definitions/BundleDetails"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Updates an existing application bundle","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Updates an existing application bundle, specified by its bundleID, with a new properties and list of associated applications.","operationId":"updateBundleUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"bundleId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the Bundle. This is obtained through the GET /v1.0/bundles command and others.","required":true,"type":"string"},{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Bundle information.","required":true,"schema":{"$ref":"#/definitions/CreateBundleRequestDTO"}}],"responses":{"200":{"description":"Success. Bundle updated Successfully.","schema":{"$ref":"#/definitions/ApiCreateBundleResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Deletes an application bundle","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Deletes the specified application bundle.","operationId":"deleteBundleUsingDELETE","produces":["application/json"],"parameters":[{"name":"bundleId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the bundle. This is obtained through the GET /v1.0/getBundles command.","required":true,"type":"string"}],"responses":{"204":{"description":"No content (success)"},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/cloudAppPools":{"get":{"tags":["APIs"],"summary":"Returns a list of all application server pools","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns a list of all application server pools, along with information about each pool, including its name, its pool id, and other information. The pool id is used by many commands to specify which pool to use. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"cloudAppPoolsUsingGET","produces":["application/json"],"responses":{"200":{"description":"List of cloud app pools","schema":{"$ref":"#/definitions/CloudAppPool"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Creates an application server pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Creates an application server pool.<br/><br/><b>Supported Clouds:</b> GCP","operationId":"createCloudAppPoolUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"createCloudAppPool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Cloud app pool information.","required":true,"schema":{"$ref":"#/definitions/CreateCloudAppPool"}}],"responses":{"200":{"description":"Creates an application server pool.","schema":{"$ref":"#/definitions/ApiCreateCloudAppPoolResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/cloudAppPools/applications":{"get":{"tags":["APIs"],"summary":"Returns a list of all application server applications","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns a list of all applications served by any application server pool (but not other kinds of RD application or Web application). This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"applicationsUsingGET","produces":["application/json"],"responses":{"200":{"description":"List of all application server applications","schema":{"$ref":"#/definitions/Applications"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Creates an application","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Creates an application server application.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"createCloudAppUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Cloud app  information.","required":true,"schema":{"$ref":"#/definitions/CreateCloudAppRequest"}}],"responses":{"200":{"description":"Application server application created successfully.","schema":{"$ref":"#/definitions/ApiCreateCloudAppResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/cloudAppPools/applications/{appId}":{"get":{"tags":["APIs"],"summary":"Returns application details","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns details about the specified application (application server applications only). This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"appDetailsUsingGET","produces":["application/json"],"parameters":[{"name":"appId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the application. This is obtained through the GET /v1.0/applications command and others.","required":true,"type":"string","x-example":"f81eed06-c7a0-46b1-a3bf-50cc8880310b"}],"responses":{"200":{"description":"Application details","schema":{"$ref":"#/definitions/ApplicationDetails"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Updates an application","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Updates an application server application.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"updateCloudAppUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"appId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string of the application. This is obtained through the GET /v1.0//cloudAppPools/applications command.","required":true,"type":"string"},{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Application server application information.","required":true,"schema":{"$ref":"#/definitions/UpdateCloudAppRequest"}}],"responses":{"200":{"description":"Application server application succesfully.","schema":{"$ref":"#/definitions/ApiCreateCloudAppResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Deletes an application","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Deletes the specified application.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"deletecloudAppUsingDELETE","produces":["application/json"],"parameters":[{"name":"appId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string of the application. This is obtained through the GET /v1.0/cloudAppPools/applications command.","required":true,"type":"string"}],"responses":{"204":{"description":"No content (success)"},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/cloudAppPools/applications/{appId}/icon":{"post":{"tags":["APIs"],"summary":"Updates an application icon","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Updates the icon of the specified application. Attach the image as the 'icon' form field, e.g. curl -F \"icon=@C:\\path\\to\\myicon.png\".<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"uploadCloudAppIconUsingPOST","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"appId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string of the application. Obtained through GET /v1.0/cloudAppPools/applications.","required":true,"type":"string"},{"name":"icon","in":"formData","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The image file to upload as the app icon (max 100 KB).","required":true,"type":"file"}],"responses":{"200":{"description":"Application icon updated successfully.","schema":{"$ref":"#/definitions/ApiCreateCloudAppResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"413":{"description":"The icon exceeds the maximum allowed size (100 KB)"}},"deprecated":false}},"/v1.0/cloudAppPools/{cloudAppPoolId}":{"get":{"tags":["APIs"],"summary":"Returns the details about an application server pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Return the details about the specified application server pool. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"cloudAppPoolInfoUsingGET","produces":["application/json"],"parameters":[{"name":"cloudAppPoolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string of the application server. This is obtained through the GET /v1.0/cloudAppPools command and others.","required":true,"type":"string","x-example":"f81eed06-c7a0-46b1-a3bf-50cc8880310b"}],"responses":{"200":{"description":"Details about the pool","schema":{"$ref":"#/definitions/CloudAppPoolDetails"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Deletes an application server pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Deletes the specified application server pool.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"deletecloudAppPoolUsingDELETE","produces":["application/json"],"parameters":[{"name":"cloudAppPoolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string of application server pool. This is obtained through the GET /v1.0/cloudAppPools command.","required":true,"type":"string"}],"responses":{"204":{"description":"No content (success)"},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/cloudAppPools/{cloudAppPoolId}/appServers":{"get":{"tags":["APIs"],"summary":"Returns a list of application servers in a pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information about every application server in the specified applicaton server pool, including the server IDs used for commands that operate on a specified  server. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"cloudAppServersUsingGET","produces":["application/json"],"parameters":[{"name":"cloudAppPoolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string of the application server. This is obtained through the GET /v1.0/cloudAppPools command and others.","required":true,"type":"string"}],"responses":{"200":{"description":"List of app servers in cloud app pool","schema":{"$ref":"#/definitions/CloudAppServers"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/cloudAppPools/{cloudAppPoolId}/appServers/{appServerId}":{"get":{"tags":["APIs"],"summary":"Returns details for a single application server","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns the details for a single application server in a specified application server pool. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"appServerDeatilsUsingGET","produces":["application/json"],"parameters":[{"name":"appServerId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the cloud app server. This is obtained through the GET /v1.0/cloudAppPools/{cloudAppPoolId}/appServers command and others.","required":true,"type":"string"},{"name":"cloudAppPoolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the cloud app pool. This is obtained through the GET /v1.0/cloudAppPools command and others.","required":true,"type":"string"}],"responses":{"200":{"description":"Details of the specified application server","schema":{"$ref":"#/definitions/CloudAppServerDetails"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Deletes a Cloud app server","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Deletes the specified cloud app server<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"deletecloudAppServerUsingDELETE","produces":["application/json"],"parameters":[{"name":"appServerId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the cloud app server. This is obtained through the GET /v1.0/cloudAppPools/{cloudAppPoolId}/appServers command and others.","required":true,"type":"string"},{"name":"cloudAppPoolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the cloud app pool. This is obtained through the GET /v1.0/cloudAppPools command and others.","required":true,"type":"string"}],"responses":{"204":{"description":"No content (success)"},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/cloudAppPools/{poolId}":{"post":{"tags":["APIs"],"summary":"Updates an application server pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Updates an application server pool.<br/><br/><b>Supported Clouds:</b> GCP","operationId":"updateCloudAppPoolUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string of the application server. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"},{"in":"body","name":"updateCloudAppPool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Application server details to updated.","required":true,"schema":{"$ref":"#/definitions/UpdateCloudAppPool"}}],"responses":{"200":{"description":"Updates the parameters of an application server pool.","schema":{"$ref":"#/definitions/ApiCreateCloudAppPoolResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds":{"get":{"tags":["APIs"],"summary":"Returns information about public clouds","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"publicCloudsUsingGET","produces":["application/json"],"responses":{"200":{"description":"Returns Cloud subscription details. This is a synchronous command.","schema":{"$ref":"#/definitions/CloudConfigSubscriptions"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/rdgateways/images":{"get":{"tags":["APIs"],"summary":"Returns information Market place images required to create gateway cluster (managed gateways)","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information about marketplace images. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"getGatewayImagesUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"query","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Returns details about market place images). This is a synchronous command.","schema":{"$ref":"#/definitions/CloudImages"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/rdgateways/vmClasses":{"get":{"tags":["APIs"],"summary":"Returns information about VM Classes required to create gateway cluster (managed gateways)","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information of VM Classes. This is a synchronous command. See <a href= https://docs.workspot.com/docs/managed-gateways-gateway-clusters> Gateway Clusters (Managed Gateways)</a> for more information<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"getGatewayVmClassesUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"query","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Returns information of VM Classes. This is a synchronous command.","schema":{"$ref":"#/definitions/VmClasses"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/customImages":{"get":{"tags":["APIs"],"summary":"Returns information about Custom Images","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> GCP, Amazon WorkSpaces Core","operationId":"customImagesUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns Custom Image details. This is a synchronous command.","schema":{"$ref":"#/definitions/CustomImageResponse"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Adds a new Custom Image","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> GCP, Amazon WorkSpaces Core","operationId":"createCustomImagesUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Custom Image information.","required":true,"schema":{"$ref":"#/definitions/AddCustomImageRequest"}},{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Custom Image added successfully. This is a synchronous command.","schema":{"$ref":"#/definitions/ApiStatusResponse"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/networks":{"get":{"tags":["APIs"],"summary":"Returns information about Cloud networks","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information of cloud networks. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> GCP","operationId":"getCloudNetworksUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns information about Cloud Networks. This is a synchronous command.","schema":{"$ref":"#/definitions/ApiCloudNetworksListResponse"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/regions":{"get":{"tags":["APIs"],"summary":"Returns list of regions","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information about regions. Only applicable for AWS subscriptions. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Amazon WorkSpaces Core","operationId":"getRegionsUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"path","description":"The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns list  of regions. This is a synchronous command.","schema":{"$ref":"#/definitions/Regions"}},"400":{"description":"Error message with details. Returns Bad request for GCP and Azure clouds"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/regions/{region}/networks":{"get":{"tags":["APIs"],"summary":"Returns information about Cloud networks in a region","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information of cloud networks in a given region. Only applicable for AWS subscriptions. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Amazon WorkSpaces Core","operationId":"getCloudNetworksByRegionUsingGET","produces":["application/json"],"parameters":[{"name":"region","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The region name from the GET /v1.0/clouds/{subscriptionName}/regions command","required":true,"type":"string"},{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns information of Cloud networks in a region. This is a synchronous command.","schema":{"$ref":"#/definitions/ApiCloudNetworksListResponse"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/regions/{region}/securityGroups":{"get":{"tags":["APIs"],"summary":"Returns information AWS security groups","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information AWS security groups. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Amazon WorkSpaces Core","operationId":"getSecurityGroupsUsingGET","produces":["application/json"],"parameters":[{"name":"region","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The region name from the GET /v1.0/clouds/{subscriptionName}/regions command","required":true,"type":"string"},{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns information of Security Groups. This is a synchronous command.","schema":{"$ref":"#/definitions/SecurityGroups"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/regions/{region}/zones":{"get":{"tags":["APIs"],"summary":"Returns list of  Zones for provided region","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information about zones for region. Note: This API is applicable for  GCP clouds only. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> GCP","operationId":"getZonesUsingGET","produces":["application/json"],"parameters":[{"name":"region","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">GCP Region Name","required":true,"type":"string"},{"name":"subscriptionName","in":"path","description":"The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns list of zones. This is a synchronous command.","schema":{"$ref":"#/definitions/Zones"}},"400":{"description":"Error message with details. Returns Bad request for AWS and Azure clouds"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/templates":{"get":{"tags":["APIs"],"summary":"Returns information about templates","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"getTemplatesUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns list of templates in the given subscription","schema":{"$ref":"#/definitions/APIGetTemplatesResponseBO"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/templates/build":{"post":{"tags":["APIs"],"summary":"Builds a new template Image","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> GCP, Amazon WorkSpaces Core","operationId":"buildTemplateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Template information","required":true,"schema":{"$ref":"#/definitions/ApiBuildTemplateRequest"}},{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Build template. This is a asynchronous command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/templates/register":{"post":{"tags":["APIs"],"summary":"Registers a new template Image","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> GCP, Amazon WorkSpaces Core","operationId":"registerTemplateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Template information","required":true,"schema":{"$ref":"#/definitions/RegisterTemplateRequestBO"}},{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Register template. This is a asynchronous command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/templates/vmClasses":{"get":{"tags":["APIs"],"summary":"Returns information about VM Classes required to create Templates","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information of VM Classes. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"getTemplateVmClassesUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns information of Template VM Classes. This is a synchronous command.","schema":{"$ref":"#/definitions/TemplateVmClasses"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/templates/{templateName}":{"get":{"tags":["APIs"],"summary":"Returns information about templates","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"getTemplateUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"},{"name":"templateName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Name of the template","required":true,"type":"string"}],"responses":{"200":{"description":"Returns template information in a cloud subscription","schema":{"$ref":"#/definitions/APIGetTemplatesResponseBO"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Deletes template from cloud subscription","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"deleteTemplateUsingDELETE","produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"},{"name":"templateName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Name of the template","required":true,"type":"string"}],"responses":{"200":{"description":"Returns status of the request (Succeeded, or Failed). If failed, provides error information","schema":{"$ref":"#/definitions/ApiStatusResponse"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/templates/{templateName}/clone":{"post":{"tags":["APIs"],"summary":"Clones a new template from an existing template","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> GCP, Amazon WorkSpaces Core","operationId":"cloneTemplateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Template information","required":true,"schema":{"$ref":"#/definitions/ApiCloneTemplateRequest"}},{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"},{"name":"templateName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The Template name","required":true,"type":"string"}],"responses":{"200":{"description":"Clone a template. This is a asynchronous command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/templates/{templateName}/draft":{"post":{"tags":["APIs"],"summary":"Draft the template","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"draftTemplateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"},{"name":"templateName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The Template name","required":true,"type":"string"}],"responses":{"200":{"description":"Draft the template. This is a asynchronous command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/templates/{templateName}/preview":{"post":{"tags":["APIs"],"summary":"Preview the template","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"previewTemplateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"},{"name":"templateName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The Template name","required":true,"type":"string"}],"responses":{"200":{"description":"Preview the template. This is a asynchronous command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/clouds/{subscriptionName}/templates/{templateName}/publish":{"post":{"tags":["APIs"],"summary":"Publish the template","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"><br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"publishTemplateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"subscriptionName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The subscription name from the GET /v1.0/clouds command","required":true,"type":"string"},{"name":"templateName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The Template name","required":true,"type":"string"}],"responses":{"200":{"description":"Publish the template. This is a asynchronous command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/desktops/{desktopId}/cancelUpgradeDesktop":{"post":{"tags":["APIs"],"summary":"Cancels a upgrade desktop operation","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Cancels a upgrade desktop operation and reboots the source desktop in its source pool. Use this command after a upgrade desktop operation fails. Otherwise, the desktop will remain unavailable. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure","operationId":"cancelUpgradeDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The desktopId","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/desktops/{desktopId}/retainDesktop":{"post":{"tags":["APIs"],"summary":"Sets the retention period for a desktop on suspension.","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The desktop will be deleted once the retention period is complete. For already suspended desktops the start of retention period will begin from the API call time. For assigned desktops the retention period will start from the suspension time. Retention period should be a non-negative integer (like 0,1,2,3,.. ). This is a synchronised command.","operationId":"retainDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The unique ID string for the desktop. This is obtained through the GET /v1.0/pools/{poolId}/desktops command and others.","required":true,"type":"string"},{"in":"body","name":"vmRetentionPeriod","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Number of days (positive integer) after which the desktop is deleted. For “0” desktop will be retained for indefinite period. ","required":true,"schema":{"$ref":"#/definitions/VMRetentionPeriod"}}],"responses":{"200":{"description":"Success. Returns updated desktop details.","schema":{"$ref":"#/definitions/VMRetentionDetails"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/desktops/{desktopId}/upgradeDesktop":{"post":{"tags":["APIs"],"summary":"Upgrades a persistent desktop to the specified pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Upgrades a persistent desktop from its current pool to the destination pool. Ownership of the desktop is preserved and the owner will launch it from its new region/pool as usual from the client interface. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure","operationId":"upgradeDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The desktopId to upgrade","required":true,"type":"string"},{"in":"body","name":"upgradeDesktopRequest","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The targetPool along with domain join details(if you do not want retain the source name). If AAD only account just provide targetPool and retainName or computerName.","required":true,"schema":{"$ref":"#/definitions/UpgradeDesktopRequest"}}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/globalDesktops":{"get":{"tags":["APIs"],"summary":"Returns information on available Global Desktop Applications","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns details about all the global desktop applications for a company. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"globalDesktopsUsingGET","produces":["application/json"],"responses":{"200":{"description":"Details about the global desktop applications.","schema":{"$ref":"#/definitions/GlobalDesktopListBO"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/globalDesktops/{globalDesktopId}":{"get":{"tags":["APIs"],"summary":"Return details of Global Desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information on available Global Desktops including pool, order of precedence and assigned group ID. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"globalDesktopUsingGET","produces":["application/json"],"parameters":[{"name":"globalDesktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Id of the global desktop","required":true,"type":"string"}],"responses":{"200":{"description":"Detail of group","schema":{"$ref":"#/definitions/GlobalDesktopBO"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/globalDesktops/{globalDesktopId}/pools":{"post":{"tags":["APIs"],"summary":"Assign pools to global desktop application","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Assign the pools with order of precedence to global desktop application. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"setGlobalDesktopGroupPoolsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"globalDesktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Global Desktop Application Id to assign pools","required":true,"type":"string"},{"in":"body","name":"poolPrecedence","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Pool IDs and precedence to be assigned. Order of precedence is a positive integer, with 1 being the highest precedence. Precedence must be given with no gaps (1, 2, 3; not 1, 4, 9).","required":true,"schema":{"$ref":"#/definitions/VDIPoolDetails"}}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/groups":{"get":{"tags":["APIs"],"summary":"Returns a list of all groups","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns a list of all group names and ids. This is a synchronous command.","operationId":"groupsUsingGET","produces":["application/json"],"responses":{"200":{"description":"List of groups","schema":{"$ref":"#/definitions/GroupsList"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/groups/{groupId}/bundle":{"post":{"tags":["APIs"],"summary":"Assigns an application bundle to a user group","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Assigns the specified application bundle to a user group.","operationId":"assignBundleUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"assignBundle","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Bundle information.","required":true,"schema":{"$ref":"#/definitions/AssignBundle"}},{"name":"groupId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Group Id ","required":true,"type":"string"}],"responses":{"200":{"description":"Success. Bundle assigned to group.","schema":{"$ref":"#/definitions/ApiCreateBundleResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/groups/{groupId}/globalDesktops":{"get":{"tags":["APIs"],"summary":"Returns information on global desktops assigned to a group","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information on global desktops assigned to a group. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"groupGlobalDesktopDetailsUsingGET","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Id of the group","required":true,"type":"string"}],"responses":{"200":{"description":"Detail of group","schema":{"$ref":"#/definitions/GlobalDesktopsList"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Assign a global desktop application to a group","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Assigns a global desktop application to a group. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"setGlobalDesktopToGroupUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"globalDesktopId","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Global Desktop Application Id to be assigned to group","required":true,"schema":{"$ref":"#/definitions/GlobalDesktopId"}},{"name":"groupId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Group Id to which global desktop application is to be assigned","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/groups/{groupId}/globalDesktops/{globalDesktopId}":{"delete":{"tags":["APIs"],"summary":"Unassign a global desktop application from a group","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Revokes group’s assignment to a global desktop application. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"unassignGlobalDesktopToGroupUsingDELETE","produces":["application/json"],"parameters":[{"name":"globalDesktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Global Desktop Application Id to be revoked from group","required":true,"type":"string"},{"name":"groupId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Group Id to which global desktop application is to be revoked from","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/licenses":{"get":{"tags":["APIs"],"summary":"Returns a list of Workspot licenses for each VM type purchased","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">For each license type, return information including the total number of licenses purchased and the number of licenses available (unassigned). In addition to desktop licenses, associated licenses such as backup licenses and disaster recovery licenses are listed. This is a synchronous command.","operationId":"getLicensesUsingGET","produces":["application/json"],"responses":{"200":{"description":"Information about all active licenses","schema":{"$ref":"#/definitions/License"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/operation/{operationId}":{"get":{"tags":["APIs"],"summary":"Returns status of an asynchronous operation","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Asynchronous operations return a StatusURL that is an instance of this command with the correct operationID. This command returns the asynchronous operation’s status (plus additional information). This is a synchronous command.","operationId":"statusCheckUsingGET","produces":["application/json"],"parameters":[{"name":"operationId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">operationId","required":true,"type":"string"}],"responses":{"200":{"description":"Returns status of the operation (inProgress, Succeeded, or Failed). Provides success details or error info once finished (Succeeded or Failed).","schema":{"$ref":"#/definitions/OpResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/policies":{"get":{"tags":["APIs"],"summary":"Get List of Policies","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Get list of policies based on the type. This is a synchronous command.","operationId":"getPoliciesUsingGET","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Policy Type. Allowed types are 'MediaRedirection', 'Gateway', 'Protocol', 'TimeLimits', 'Maintenance', 'Warmup'","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Returns list of policies of the provided type.","schema":{"$ref":"#/definitions/GetPoliciesResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools":{"get":{"tags":["APIs"],"summary":"Returns a list of all desktop pools","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns a list of all desktop pools, along with information about each pool, including its name, its pool id, and other information. The pool id is used by many other commands to specify which pool to use. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"poolsUsingGET","produces":["application/json"],"responses":{"200":{"description":"List of pools","schema":{"$ref":"#/definitions/Pool"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Creates Desktop Pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Creates desktop pool by taking reference from another desktop pool. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> GCP","operationId":"createDesktopPoolUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">This is desktop pool create request.","required":true,"schema":{"$ref":"#/definitions/CreateDesktopPoolRequest"}}],"responses":{"200":{"description":"Returns status of Desktop Pool creation.If status is success, then use /pool/{poolId}/status API to check pool and desktop status.","schema":{"$ref":"#/definitions/CreateDesktopPoolResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/loginOptions":{"get":{"tags":["APIs"],"summary":"Get login options for desktop pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Get list of possible login options for pool. This is a synchronous command.","operationId":"getLoginOptionsUsingGET","produces":["application/json"],"responses":{"200":{"description":"Returns list of possible pool login options.","schema":{"$ref":"#/definitions/GetLoginOptionsResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}":{"get":{"tags":["APIs"],"summary":"Returns the details for a single pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Using the poolId, return the details about the specified pool. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"poolInfoUsingGET","produces":["application/json"],"parameters":[{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string","x-example":"f81eed06-c7a0-46b1-a3bf-50cc8880310b"}],"responses":{"200":{"description":"Details about the pool","schema":{"$ref":"#/definitions/DesktopPoolDetails"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/agentToken":{"get":{"tags":["APIs"],"summary":"Returns Agent token for the pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns a valid, unexpired Agent Token for the specified pool, which can be used to register desktop in the pool. This is a synchronous command.","operationId":"poolAgentTokenUsingGET","produces":["application/json"],"parameters":[{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"200":{"description":"Agent Token Details for the specified pool","schema":{"$ref":"#/definitions/PoolAgentTokenDetails"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/customdesktop":{"post":{"tags":["APIs"],"summary":"Creates a desktop in custom cloud pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Adds an existing VM to a Custom Cloud Pool. This is a synchronous command.","operationId":"createCustomDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"desktopToCreate","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Except for the Computer Name, these are existing parameters of the desktop VM. Computer Name is a unique string used by Control to display information about this VM. It should be no more than fifteen characters long and consist of only alphanumeric and dash characters. You must specify at least a Computer Name and either a BIOS GUID or both a MAC Address and an FQDN.","required":true,"schema":{"$ref":"#/definitions/CreateCustomDesktop"}},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"200":{"description":"Success. Desktop added successfully to the pool","schema":{"$ref":"#/definitions/ApiCustomDesktopCreateResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops":{"get":{"tags":["APIs"],"summary":"Returns a list of desktops in a pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information about every desktop in the specified pool, including their desktop ids, which are used for commands that operate on a specified desktop. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"getpoolDesktopsUsingGET","produces":["application/json"],"parameters":[{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"200":{"description":"List of desktops in pool","schema":{"$ref":"#/definitions/DesktopList"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Creates a desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Creates a desktop in the specified pool. Optionally, the computerName can be specified. Otherwise it is assigned based on the pool's Desktop Name and an unused number (for example, mypool-004). The computerName must consist only of alphanumeric characters and hyphens, and cannot start with a numeral or hyphen. Optionally, the snapshot from which the disk of the desktop is created can be specified. Otherwise,  it is created with empty disk. The snapshotId should be the unique identifier of the snapshot on cloud.This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"createDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"desktopToCreate","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Optional parameters. The currently defined parameters are computerName and snapshotId along with domain join details (if desktop is being created with specified snapshot).","required":false,"schema":{"$ref":"#/definitions/CreateDesktop"}},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops/{desktopId}":{"get":{"tags":["APIs"],"summary":"Returns details for a single desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns the details for a single, specified desktop in a specified pool. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"desktopDetailsUsingGET","produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the desktop. This is obtained through the GET /v1.0/pools/{poolId}/desktops command and others.","required":true,"type":"string"},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"200":{"description":"Details for the specified desktop","schema":{"$ref":"#/definitions/Desktop"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Deletes a desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Deletes the specified desktop. If the pool uses the \"Auto Create on Delete Desktop\" option, the desktop will be recreated from the pool template. Otherwise, is will be be deleted and the size of the pool will be reduced by one. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"deleteDesktopUsingDELETE","produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the desktop. This is obtained through the GET /v1.0/pools/{poolId}/desktops command and others.","required":true,"type":"string"},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"204":{"description":"No content (success)"},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops/{desktopId}/attachSnapshot":{"post":{"tags":["APIs"],"summary":"Attaches a snapshot to a desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Attaches the specified snapshot to the desktop. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Amazon WorkSpaces Core","operationId":"attachSnapshotUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"attachSnapshot","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The snapshot detail along with domain join details. If AAD only account just provide the snapshot to be restored on the desktop.","required":true,"schema":{"$ref":"#/definitions/AttachSnapshot"}},{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the desktop. This is obtained through the GET /v1.0/pools/{poolId}/desktops command and others.","required":true,"type":"string"},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops/{desktopId}/cancelMoveDesktop":{"post":{"tags":["APIs"],"summary":"Cancels a move desktop operation","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Cancels a move desktop operation and reboots the source desktop in its original pool. Use this command after a move desktop operation fails. Otherwise, the desktop will remain unavailable. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure","operationId":"cancelMoveDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The source desktopId","required":true,"type":"string"},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The source poolId","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops/{desktopId}/moveDesktop":{"post":{"tags":["APIs"],"summary":"Moves a persistent desktop to the specified pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Moves a persistent desktop from its current pool to the destination pool. Ownership of the desktop is preserved and the owner will launch it in its new location as if nothing has happened. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure","operationId":"moveDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The desktopId to move","required":true,"type":"string"},{"in":"body","name":"moveDesktopRequest","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The user's email address and targetPool Id to which desktop need to be moved.","required":true,"schema":{"$ref":"#/definitions/MoveDesktopRequest"}},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The source poolId","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops/{desktopId}/pause":{"post":{"tags":["APIs"],"summary":"Pauses a desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Pauses a desktop. Valid for persistent desktops only. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"pauseDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the desktop. This is obtained through the GET /v1.0/pools/{poolId}/desktops command and others.","required":true,"type":"string"},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops/{desktopId}/reboot":{"post":{"tags":["APIs"],"summary":"Reboots a desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Reboots a desktop. Valid for persistent desktops only. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"rebootDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the desktop. This is obtained through the GET /v1.0/pools/{poolId}/desktops command and others.","required":true,"type":"string"},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops/{desktopId}/redeploy":{"post":{"tags":["APIs"],"summary":"Redeploys a desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Replace a desktop with a fresh one built from the current pool template. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure","operationId":"redeployDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the desktop. This is obtained through the GET /v1.0/pools/{poolId}/desktops command and others.","required":true,"type":"string"},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops/{desktopId}/resume":{"post":{"tags":["APIs"],"summary":"Resumes a desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Resumes a desktop. Valid for persistent desktops only. This is an asynchronous command. If duration is included, pausing the desktop is not allowed for specified duration. Otherwise, it is a simple resume request to get the desktops running.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"resumeDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the desktop. This is obtained through the GET /v1.0/pools/{poolId}/desktops command and others.","required":true,"type":"string"},{"in":"body","name":"duration","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Optional parameter (in minutes). Desktop pausing not allowed till this duration.","required":false,"schema":{"$ref":"#/definitions/HydrateDuration"}},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops/{desktopId}/screenshotDesktop":{"post":{"tags":["APIs"],"summary":"Takes a screen shot of the desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Capture the display on the desktop to debug boot and login issues. If a user is logged on, this feature is unavailable. A link to the screen shot image is returned in the body of the operation command (statusURL) after the screenShotDesktop command succeeds. The image expires after 15 minutes. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure","operationId":"screenshotDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the desktop. This is obtained through the GET /v1.0/pools/{poolId}/desktops command and others.","required":true,"type":"string"},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolId}/desktops/{desktopId}/tags":{"post":{"tags":["APIs"],"summary":"Sets tags for a desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Set customer-defined name/value pairs (tags) for a desktop. Once set, tags returned by the desktop details command (GET /v1.0/pools/{poolId}/desktops/{desktopId}). Tags are valid only for persistent desktops. This is a synchronous command. See <a href=https://docs.workspot.com/docs/using-desktop-tags-in-the-workspot-control-api>Using Desktop Tags in the Workspot Control API</a> for more information.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"tagDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the desktop. This is obtained through the GET /v1.0/pools/{poolId}/desktops command and others.","required":true,"type":"string"},{"name":"poolId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The ID string for the pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"},{"in":"body","name":"tagRequest","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">A series of name/value pairs (tags)","required":false,"schema":{"$ref":"#/definitions/TagDesktopRequest"}}],"responses":{"200":{"description":"Tags have been set successfully"},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/pools/{poolName}":{"post":{"tags":["APIs"],"summary":"Updates a desktop pool.","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Updated desktop pool. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> GCP","operationId":"updateDesktopPoolUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"poolName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The name of the desktop pool. This is obtained through the GET /v1.0/pools command and others.","required":true,"type":"string"},{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">This is desktop pool update request.","required":true,"schema":{"$ref":"#/definitions/UpdateDesktopPoolRequest"}}],"responses":{"200":{"description":"Updates the desktop pool","schema":{"$ref":"#/definitions/CreateDesktopPoolResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/authenticationOptions":{"get":{"tags":["APIs"],"summary":"Returns information about authentication options required to create gateway cluster (managed gateways)","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information about authentication options. This is a synchronous command. See <a href= https://docs.workspot.com/docs/managed-gateways-gateway-clusters> Gateway Clusters (Managed Gateways)</a> for more information","operationId":"getAuthenticationOptionsUsingGET","produces":["application/json"],"responses":{"200":{"description":"Returns details authentication options used to create  cluster (managed RD Gateway). This is a synchronous command.","schema":{"$ref":"#/definitions/AuthenticationOptions"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/clusters":{"get":{"tags":["APIs"],"summary":"Returns information about each gateway cluster (managed gateways)","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information about each gateway cluster (managed RD Gateways). Not applicable to legacy RD Gateways. This is a synchronous command. See <a href= https://docs.workspot.com/docs/managed-gateways-gateway-clusters> Gateway Clusters (Managed Gateways)</a> for more information<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"gwClustersUsingGET","produces":["application/json"],"responses":{"200":{"description":"Returns details about each gateway cluster (managed RD Gateway), including status information and a list of pools and apps using each cluster. Not applicable to legacy RD Gateways. This is a synchronous command.","schema":{"$ref":"#/definitions/Clusters"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Creates Gateway Cluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Creates public cloud gateway cluster. This is an asynchronous command.npsServers field is required only if AuthOption field is NPS and gatewayPolicyName is mandatory if authOption is other than NPS.Note that gatewayPolicyName and npsServers are mutually exclusive and cannot be sent together in payload<br/><br/><b>Supported Clouds:</b> GCP, Amazon WorkSpaces Core","operationId":"createGWClusterUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"createCluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">This is Create Gateway cluster request requires,Cluster Name which is unique, region and network.","required":true,"schema":{"$ref":"#/definitions/GWCreateCluster"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways":{"get":{"tags":["APIs"],"summary":"Returns information about each gateway in a given cluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns details about each gateway VM in a specified cluster (managed RD Gateway), including the number of active connections, certificate information, and status.This is a synchronous command. See <a href= https://docs.workspot.com/docs/managed-gateways-gateway-clusters> Gateway Clusters (Managed Gateways)</a> for more information<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"gwClusterHostsUsingGET","produces":["application/json"],"parameters":[{"name":"clusterId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterId from the GET /v1.0/rdgateways/clusters/ command","required":true,"type":"string"},{"name":"clusterRegionId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterRegionId from the GET /v1.0/rdgateways/clusters/ command","required":true,"type":"string"}],"responses":{"200":{"description":"List of gateways in the cluster and information about each gateway.","schema":{"$ref":"#/definitions/Hosts"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways/{gatewayId}/connections":{"get":{"tags":["APIs"],"summary":"Returns information about the Client connections for a gateway in the specified gateway cluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns information about the Client connections for a gateway in the specified gateway cluster, including the number of active connections and average request auth seconds.This is a synchronous command. See <a href= https://docs.workspot.com/docs/managed-gateways-gateway-clusters> Gateway Clusters (Managed Gateways)</a> for more information<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"getGWHostConnectionsUsingGET","produces":["application/json"],"parameters":[{"name":"clusterId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterId from the GET /v1.0/rdgateways/clusters/ command","required":true,"type":"string"},{"name":"clusterRegionId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterRegionId from the GET /v1.0/rdgateways/clusters command","required":true,"type":"string"},{"name":"gatewayId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The gatewayId from the GET /v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways command","required":true,"type":"string"}],"responses":{"200":{"description":"Gateway connections in a specified cluster (managed RD Gateway)","schema":{"$ref":"#/definitions/GWClusterHostConnectionDetails"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways/{gatewayId}/performance":{"get":{"tags":["APIs"],"summary":"Returns system performance statistics such as CPU and memory usage for a gateway in the specified cluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns system performance statistics such as CPU and memory usage for a gateway in the specified cluster, including the cpu and memory data.This is a synchronous command. See <a href= https://docs.workspot.com/docs/managed-gateways-gateway-clusters> Gateway Clusters (Managed Gateways)</a> for more information<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"getGWHostPerformanceUsingGET","produces":["application/json"],"parameters":[{"name":"clusterId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterId from the GET /v1.0/rdgateways/clusters/ command","required":true,"type":"string"},{"name":"clusterRegionId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterRegionId from the GET /v1.0/rdgateways/clusters command","required":true,"type":"string"},{"name":"gatewayId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The gatewayId from the GET /v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways command","required":true,"type":"string"}],"responses":{"200":{"description":"Gateway performance data (cpu/memory) in a specified cluster (managed RD Gateway)","schema":{"$ref":"#/definitions/GWClusterHostPerformanceDetails"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/clusters/{clusterName}":{"post":{"tags":["APIs"],"summary":"Updates GatewayCluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Gateway cluster updates currently support modifications to only the following fields: imageName, vmClassName, gatewayPolicyName, and npsServers. Note that gatewayPolicyName and npsServers are mutually exclusive and cannot be sent together in payload<br/><br/><b>Supported Clouds:</b> GCP, Amazon WorkSpaces Core","operationId":"updateGatewayCusterUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"clusterName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterName from the GET /v1.0/rdgateways/clusters command","required":true,"type":"string"},{"in":"body","name":"updateCluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\"> modifications to only the following fields: imageName, vmClassName, gatewayPolicyName, and npsServers. Note that gatewayPolicyName and npsServers are mutually exclusive and cannot be sent together in payload","required":true,"schema":{"$ref":"#/definitions/GWUpdateCluster"}}],"responses":{"200":{"description":"Returns status of the request (Succeeded, or Failed). If failed, provides error information","schema":{"$ref":"#/definitions/GWUpdateClusterResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Deletes GatewayCluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Deletes Gateway cluster<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"deleteGatewayClusterUsingDELETE","produces":["application/json"],"parameters":[{"name":"clusterName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterName from the GET /v1.0/rdgateways/clusters command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns status of the request (Succeeded, or Failed). If failed, provides error information","schema":{"$ref":"#/definitions/GWClusterActionResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/clusters/{clusterName}/gateways":{"post":{"tags":["APIs"],"summary":"Creates Gateway Host in a cluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Adds public cloud gateway host in a cluster.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"addGwHostUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"clusterName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterId from the GET /v1.0/rdgateways/clusters command","required":true,"type":"string"},{"in":"body","name":"gwAddGwHost","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Provide local admin credentials and domain join information","required":true,"schema":{"$ref":"#/definitions/GWAddGwHost"}}],"responses":{"200":{"description":"Returns status of the request (Succeeded, or Failed). If failed, provides error information","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/clusters/{clusterName}/gateways/{gatewayName}":{"delete":{"tags":["APIs"],"summary":"Deletes Gateway Host from a cluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Deletes public cloud gateway host from a cluster<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"deleteGwHostUsingDELETE","produces":["application/json"],"parameters":[{"name":"clusterName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterName from the GET /v1.0/rdgateways/clusters command","required":true,"type":"string"},{"name":"gatewayName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The gatewayName from the GET /v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns status of the request (Succeeded, or Failed). If failed, provides error information","schema":{"$ref":"#/definitions/ApiStatusResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/clusters/{clusterName}/gateways/{gatewayName}/enable":{"post":{"tags":["APIs"],"summary":"Enables Gateway Host from a cluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Enables public cloud gateway host from a cluster<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"enableGWHostUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"clusterName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterName from the GET /v1.0/rdgateways/clusters command","required":true,"type":"string"},{"name":"gatewayName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The gatewayName from the GET /v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns status of the request (Succeeded, or Failed). If failed, provides error information","schema":{"$ref":"#/definitions/ApiStatusResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/clusters/{clusterName}/gateways/{gatewayName}/reboot":{"post":{"tags":["APIs"],"summary":"Reboots Gateway Host from a cluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Reboots public cloud gateway host from a cluster<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"rebootGwHostUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"clusterName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterName from the GET /v1.0/rdgateways/clusters command","required":true,"type":"string"},{"name":"gatewayName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The gatewayName from the GET /v1.0/rdgateways/clusters/{clusterId}/regions/{clusterRegionId}/rdgateways command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns status of the request (Succeeded, or Failed). If failed, provides error information","schema":{"$ref":"#/definitions/ApiStatusResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/rdgateways/clusters/{clusterName}/publish":{"post":{"tags":["APIs"],"summary":"Publish GatewayCluster","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Publishes Gateway cluster<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"publishGatewayClusterUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"clusterName","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The clusterName from the GET /v1.0/rdgateways/clusters command","required":true,"type":"string"}],"responses":{"200":{"description":"Returns status of the request (Succeeded, or Failed). If failed, provides error information","schema":{"$ref":"#/definitions/GWClusterActionResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/reports/generateusagereport":{"post":{"tags":["APIs"],"summary":"Generates a report of active users","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Generate a report of active users covering up to thirty days. The report URL is linked in the body of the GET /v1.0/operation/{operationId} response. See <a href= https://docs.workspot.com/v1/docs/using-the-workspot-control-api>Using the Workspot Control API</a> for more information, including an example of using this command. This is an asynchronous command.","operationId":"usageReportUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"report","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Parameters for generating the usage report, including the start and end date. The start date must be no more than 30 days in the past.","required":false,"schema":{"$ref":"#/definitions/UsageReport"}}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/reports/users":{"get":{"tags":["APIs"],"summary":"Generates a report of all users and their resource assignments","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Generates a complete snapshot of every user in the tenant, including role, group memberships, persistent desktop assignments, NP pool entitlements, and last login timestamps. The download URL, which is a pre-signed URL, is returned in the response body of the GET /v1.0/operation/{operationId} API under details.downloadUrl when status is Succeeded. The response also includes the expiration time (in seconds) for the download URL. This is an asynchronous command.","operationId":"generateAllUsersReportUsingGET","produces":["application/json"],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/staleDevices":{"get":{"tags":["APIs"],"summary":"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]","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns list of stale device details. Applicable for Entra-ID-Only (Azure-AD-Only) tenants. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure","operationId":"staleDevicesUsingGET","produces":["application/json"],"parameters":[{"name":"endDate","in":"query","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">End Date. Optional","required":false,"type":"string","allowEmptyValue":false},{"name":"pageNumber","in":"query","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Page Number. Optional","required":false,"type":"string","default":"1","allowEmptyValue":false},{"name":"startDate","in":"query","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Start Date. Optional","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Returns list of Stale devices for  for given timelines. This is a synchronous command.","schema":{"$ref":"#/definitions/StaleDevices"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Deletes given list of stale devices from Control.","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Deletes the specified devices from Control. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure","operationId":"deleteStaleDevicesUsingDELETE","produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Please provide the deviceId (identifier for the device in Control) from the Get API response for the devices to be deleted. Multiple deviceIds can be passed.","required":false,"schema":{"$ref":"#/definitions/DeleteStaleDeviceRequest"}}],"responses":{"204":{"description":"No content (success)"},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users":{"post":{"tags":["APIs"],"summary":"Creates a user","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Creates a new end-user. If a poolId is specified, the user is assigned a desktop in that pool, if available. This is an asynchronous command","operationId":"addUserUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"user","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">User parameters. Email, firstName, lastName, and optional poolId.","required":true,"schema":{"$ref":"#/definitions/AddUser"}}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/":{"get":{"tags":["APIs"],"summary":"Returns user details","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns details about a specified user. This is a synchronous command.","operationId":"userDetailsUsingGET","produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">User's email.","required":true,"type":"string"}],"responses":{"200":{"description":"List of assigned desktops, list of assigned pools, cost center, etc.","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Deletes a user","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Deletes the user with the given email. Workspot Control deallocates or suspends the user's desktops and forgets the user's existence. This is a synchronous command.","operationId":"deleteUserUsingDELETE","produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The user's email address","required":true,"type":"string"}],"responses":{"204":{"description":"No content (success)"},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/assignCostCenter":{"post":{"tags":["APIs"],"summary":"Assigns a cost center to a user","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Assigns the specified cost center to the user with the specified email. This is a synchronous command. See <a href= https://docs.workspot.com/docs/workspot-control-using-the-cost-center-feature>Using the Cost Center Feature in Workspot Control.","operationId":"assignCostCenterUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"costCenter","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The name of the cost center to assign","required":true,"schema":{"$ref":"#/definitions/Cost Center to Assign"}},{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The user's email address","required":true,"type":"string"}],"responses":{"200":{"description":"Success. Returns updated user details.","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/desktops":{"post":{"tags":["APIs"],"summary":"Assigns a desktop to a user","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Assigns a specified existing desktop to the user with specified email.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"assignDesktopUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Desktop ID of the desktop being assigned","required":true,"schema":{"$ref":"#/definitions/Desktop to Assign"}},{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The user's email address","required":true,"type":"string"}],"responses":{"200":{"description":"Success. Returns updated user details.","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/desktops/{desktopId}":{"delete":{"tags":["APIs"],"summary":"Unassigns a desktop from user","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Revokes a user's assignment to a specified desktop. The desktop will be suspended or returned to the pool, depending on pool settings. See <a href=https://docs.workspot.com/docs/control-desktop-pools>Control: Desktop Pools</a> for more information<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"unassignDesktopUsingDELETE","produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Desktop ID of the desktop whose assignment is being revoked","required":true,"type":"string"},{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The current user's email address.","required":true,"type":"string"}],"responses":{"204":{"description":"No content (success)"},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/globalDesktops/{globalApplicationId}":{"delete":{"tags":["APIs"],"summary":"Unassign Global Desktop Application from a user","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Unassign a global desktop application from a user with specified email. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"unAssignAppToUserUsingDELETE","produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Email id of user","required":true,"type":"string"},{"name":"globalDesktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Global Desktop Application Id to be unassigned.","required":true,"type":"string"}],"responses":{"204":{"description":"No content (success)"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/globalDesktops/{globalDesktopId}":{"get":{"tags":["APIs"],"summary":"Returns Global Desktop Application details for a user","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Returns global desktop application  details for a user including pool, desktop details and order of precedence. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"globalDesktopDetailsUsingGET","produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Email id of user","required":true,"type":"string"},{"name":"globalDesktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Global Desktop Application Id","required":true,"type":"string"}],"responses":{"200":{"description":"List of Global Desktops Application with assigned pools and desktops.","schema":{"$ref":"#/definitions/UserGlobalDesktopPoolDetailsBO"}},"400":{"description":"Error message with details"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/globalDesktops/{globalDesktopId}/pools":{"post":{"tags":["APIs"],"summary":"Assign pools to user’s global desktop application ","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Assign the pools with order of precedence to  user’s global desktop application. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"setGlobalDesktopPoolsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Email id of user","required":true,"type":"string"},{"name":"globalDesktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Global Desktop Application Id for the User","required":true,"type":"string"},{"in":"body","name":"poolPrecedence","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Pool IDs and precedence to be assigned to override predefined global desktop pools. Order of precedence is a positive integer, with 1 being the highest precedence. Precedence must be given with no gaps (1, 2, 3; not 1, 4, 9).","required":false,"schema":{"$ref":"#/definitions/VDIPoolDetails"}}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Deallocate the pools from user’s global desktop application","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Deallocate the pools from user’s global desktop application, keeping the relative precedence for rest of the pools but renumbering them starting at 1. This is a synchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"deleteGlobalDesktopPoolsUsingDELETE","produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Email id of user","required":true,"type":"string"},{"name":"globalDesktopId","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Global desktop Application Id.","required":true,"type":"string"},{"in":"body","name":"poolId","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">PoolId to be deallocated from user’s global desktop application.","required":true,"schema":{"$ref":"#/definitions/Pool to Delete from GlobalDesktop"}}],"responses":{"200":{"description":"Pools assigned to user’s global desktop application","schema":{"$ref":"#/definitions/UserGlobalDesktopPoolDetailsBO"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/logoff":{"post":{"tags":["APIs"],"summary":"Signs a user out of a desktop session","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Signs the user out of Windows on the specified desktop. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"logoffUserUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The user's email address","required":true,"type":"string"},{"in":"body","name":"remoteSessionDesktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The desktopID and poolID of the desktop","required":true,"schema":{"$ref":"#/definitions/RemoteSessionDesktop"}}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/pools":{"post":{"tags":["APIs"],"summary":"Assigns a user to a given pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Assigns a desktop from a pool to the user. If a desktop is not available, a desktop is created and assigned to the user. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core, Akamai","operationId":"assignPoolUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The user's email address","required":true,"type":"string"},{"in":"body","name":"pool","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">poolID of pool to assign to the user","required":true,"schema":{"$ref":"#/definitions/Pool to Assign"}}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/refreshGroupEntitlements":{"post":{"tags":["APIs"],"summary":"Refreshes group entitlements for given user","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">User group entitlements will be updated when they (re)launch the Workspot client.","operationId":"refreshGroupEntitlementsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The user's email address","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RefreshEntitlementsResponse"}},"204":{"description":"No content (success)","schema":{"$ref":"#/definitions/RefreshEntitlementsResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/remoteAssistanceInvitation":{"post":{"tags":["APIs"],"summary":"Invites a user to a remote assistance session","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Invite the user of a specified desktop to a remote assistance session. This is an asynchronous command. See <a href = https://docs.workspot.com/docs/workspot-remote-assist>Workspot Remote Assist.</a> for more information.<br/><br/><b>Supported Clouds:</b> Azure","operationId":"remoteAssistUserUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The user's email address","required":true,"type":"string"},{"in":"body","name":"remoteAssistanceInvitation","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">desktopId and poolId of the user's desktop, and the remote assist password","required":true,"schema":{"$ref":"#/definitions/RemoteAssistDesktop"}}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/v1.0/users/{email}/sendMessage":{"post":{"tags":["APIs"],"summary":"Sends a message to a user's desktop","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">Send a brief message to the specified desktop of a single user. This is typically used to warn users of impending shutdowns. This is an asynchronous command.<br/><br/><b>Supported Clouds:</b> Azure, GCP, Amazon WorkSpaces Core","operationId":"sendMessageToUserUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"email","in":"path","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The user's email address","required":true,"type":"string"},{"in":"body","name":"remoteSessionDesktopMsg","description":"<span style=\"font-family: Open Sans,sans-serif; font-size:13px\">The user's desktopId and poolId, the amount of time to display the message, and the message (1-250 characters)","required":true,"schema":{"$ref":"#/definitions/RemoteSessionDesktopMessage"}}],"responses":{"202":{"description":"Request accepted. Returns a statusURL for polling, which is an instance of the GET /v1.0/operation/{operationId} command.","schema":{"$ref":"#/definitions/AsyncOperationStatus"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}}},"definitions":{"APIGetTemplatesResponseBO":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/definitions/APIMasterTemplateBO"}}},"title":"APIGetTemplatesResponseBO"},"APIMasterTemplateBO":{"type":"object","properties":{"assignedPools":{"type":"array","example":"pool1","items":{"type":"string"}},"cpu":{"type":"integer","format":"int32","example":2},"fqdn":{"type":"string","example":"DESKTOP-N4H5S59"},"lastUpdatedDate":{"type":"string","example":"Date"},"maintenancePolicyName":{"type":"string","example":"maintenancePolicy1"},"memory":{"type":"string","example":"7680 MB"},"name":{"type":"string","example":"base-win11"},"parentTemplate":{"type":"string","example":"Template"},"pauseResumeSupported":{"type":"boolean"},"provider":{"type":"string","example":"Custom Image"},"region":{"type":"string","example":"Global"},"status":{"type":"string","example":"Published"},"storage":{"type":"string","example":"80 GB"},"templateOs":{"type":"string","example":"Microsoft Windows Server 2025 Datacenter"},"templateOsType":{"type":"string","example":"Windows"},"templateType":{"type":"string","example":"Cloud Desktop"}},"title":"APIMasterTemplateBO"},"AddCustomImageRequest":{"type":"object","properties":{"imageName":{"type":"string","example":"base-w10image (from the GET /v1.0/clouds/{subscriptionName}/customImages command)"},"imageType":{"type":"string","example":"Windows Server"},"region":{"type":"string","example":"us-east-1"}},"title":"AddCustomImageRequest"},"AddUser":{"type":"object","properties":{"email":{"type":"string","example":"dsmith@example.com"},"firstName":{"type":"string","example":"David"},"lastName":{"type":"string","example":"Smith"},"poolId":{"type":"string","example":"8bb27ac0-b3ce-455b-8a30-3aed537fd45f"}},"title":"AddUser"},"ApiBuildTemplateRequest":{"type":"object","properties":{"domainToJoin":{"example":"w11image","$ref":"#/definitions/GWDomainToJoinBO"},"imageName":{"type":"string","example":"w11image"},"networkId":{"type":"string","example":"https://www.googleapis.com/compute/v1/projects/project-name/global/networks/networkName"},"notes":{"type":"string","example":"First template"},"securityGroupId":{"type":"string","example":"sg-01adedae730e9117b"},"setupDomainJoin":{"type":"boolean","example":true},"templateName":{"type":"string","example":"Win11-Template"},"templateOS":{"type":"string","example":"Windows"},"templateType":{"type":"string","example":"Cloud Desktop"},"vmType":{"type":"string","example":"Standard VM"},"zone":{"type":"string","example":"asia-south1-a"}},"title":"ApiBuildTemplateRequest"},"ApiCloneTemplateRequest":{"type":"object","properties":{"name":{"type":"string","example":"base-win11-clone"},"networkId":{"type":"string","example":"https://www.googleapis.com/compute/v1/projects/project-name/global/networks/networkName"},"notes":{"type":"string","example":"Notes"},"region":{"type":"string","example":"asia-south1"},"securityGroupId":{"type":"string","example":"sg-1234567890"},"zone":{"type":"string","example":"asia-south1-a"}},"title":"ApiCloneTemplateRequest"},"ApiCloudNetworksListResponse":{"type":"object","properties":{"cloudNetworks":{"type":"array","items":{"$ref":"#/definitions/ApiCloudNetworksResponseBO"}}},"title":"ApiCloudNetworksListResponse"},"ApiCloudNetworksResponseBO":{"type":"object","properties":{"cidr":{"type":"string","example":"10.999.9.9/20"},"cloudRegion":{"$ref":"#/definitions/ApiCloudRegionBO"},"networkID":{"type":"string","example":"https://www.googleapis.com/compute/v1/projects/project-name/global/networks/networkName"},"networkName":{"type":"string","example":"networkName\\asiaeast1"},"vpcId":{"type":"string","example":"vpcId"},"zone":{"type":"string","example":"asia-east1-a"}},"title":"ApiCloudNetworksResponseBO"},"ApiCloudRegionBO":{"type":"object","properties":{"location":{"type":"string","example":"Changhua County, Taiwan"},"region":{"type":"string","example":"asia-east1"}},"title":"ApiCloudRegionBO"},"ApiCreateBundleResponse":{"type":"object","properties":{"details":{"$ref":"#/definitions/BundleDetails"},"status":{"type":"string","example":"Succeeded"}},"title":"ApiCreateBundleResponse"},"ApiCreateCloudAppPoolResponse":{"type":"object","properties":{"details":{"$ref":"#/definitions/CloudAppPoolDetails"},"status":{"type":"string","example":"Succeeded"}},"title":"ApiCreateCloudAppPoolResponse"},"ApiCreateCloudAppResponse":{"type":"object","properties":{"details":{"$ref":"#/definitions/ApplicationDetails"},"status":{"type":"string","example":"Succeeded"}},"title":"ApiCreateCloudAppResponse"},"ApiCustomDesktopCreateResponse":{"type":"object","properties":{"details":{"$ref":"#/definitions/CustomDesktopDTO"},"status":{"type":"string","example":"Succeeded"}},"title":"ApiCustomDesktopCreateResponse"},"ApiStatusResponse":{"type":"object","properties":{"details":{"type":"object","example":"Details about the response"},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"status":{"type":"string","example":"Succeeded"}},"title":"ApiStatusResponse"},"ApplicationDetails":{"type":"object","properties":{"applicationType":{"type":"string","example":"Cloud Application"},"bundles":{"type":"array","example":"f9ad04bc-cbfc-47bd-aaa2-78ed27925018","items":{"type":"string"}},"cloudAppType":{"type":"string","example":"Custom Application"},"fullPath":{"type":"string","example":"C:\\Program Files\\Programs\\program.exe"},"gatewayClusterId":{"type":"string","example":"f9ad04bc-cbfc-47bd-aaa2-78ed27925018"},"id":{"type":"string","example":"f9ad04bc-cbfc-47bd-aaa2-78ed27925018"},"loginOption":{"type":"string","example":"SSO_DOMAIN_USER_PASSWD"},"name":{"type":"string","example":"Graphics app"},"parameters":{"type":"string","example":"-fullscreen -profile default"},"poolId":{"type":"string","example":"d8ad04bc-cbfc-47bd-aaa2-78ed27925091"},"poolName":{"type":"string","example":"Cloudapp Pool Name"},"routeThroughGateway":{"type":"string","example":"Always"},"serverType":{"type":"string","example":"Workspot Cloud App pools"},"targetPlatforms":{"type":"array","example":["iOS", "Windows", "Android", "OSX"],"items":{"type":"string"}}},"title":"ApplicationDetails"},"Applications":{"type":"object","properties":{"applications":{"type":"array","items":{"$ref":"#/definitions/ApplicationDetails"}}},"title":"Applications"},"AssignBundle":{"type":"object","properties":{"bundleId":{"type":"string","example":"73dc410b-6b13-40c6-32sd-32d4c175117c","description":"Id of bundle to assign"}},"title":"AssignBundle"},"AssignedDesktopBO":{"type":"object","properties":{"desktopFqdn":{"type":"string","example":"test-004.indevqa.ws"},"desktopId":{"type":"string","example":"d5af7ab8-31e8-4150-94c3-0e4df20353fc"},"desktopIpAddress":{"type":"string","example":"10.60.0.54"},"desktopName":{"type":"string","example":"TestPool-001"}},"title":"AssignedDesktopBO"},"AssignedPoolDesktopDetailsBO":{"type":"object","properties":{"assignedDesktop":{"$ref":"#/definitions/AssignedDesktopBO"},"poolId":{"type":"string","example":"2f102d72-8c58-460b-9dbf-c32d6a84f9f2"},"poolName":{"type":"string","example":"TestPool"},"precendence":{"type":"integer","format":"int32","example":1}},"title":"AssignedPoolDesktopDetailsBO"},"AsyncOperationStatus":{"type":"object","properties":{"statusURL":{"type":"string","example":"https://api.workspot.com/v1.0/operation/7ad1cd2f-7056-4cdf-9ce9-36e95f7db1f8"}},"title":"AsyncOperationStatus"},"AttachSnapshot":{"type":"object","required":["snapshotId"],"properties":{"domainOU":{"type":"string","example":"OU=WSVDI,DC=indevqa,DC=ws","description":"Domain OU"},"domainPWD":{"type":"string","example":"pswrd*","description":"Password for Domain Join"},"domainToJoin":{"type":"string","example":"indevqa.ws","description":"Domain name"},"domainUser":{"type":"string","example":"indevqa.ws\\johns","description":"Username"},"snapshotId":{"type":"string","example":"snap-06fb57fa7342bb456"}},"title":"AttachSnapshot"},"AuthenticationOptions":{"type":"object","properties":{"authenticationOptions":{"type":"array","example":[ "AD", "AAD", "NPS"],"items":{"type":"string"}},"idp":{"type":"array","example":["dev_okta", "IdpTest", "mvp_okta"],"items":{"type":"string"}},"publicDomainName":{"type":"string","example":"test.com"}},"title":"AuthenticationOptions"},"BundleDetails":{"type":"object","properties":{"apps":{"type":"array","items":{"$ref":"#/definitions/KeyValuePairBO"}},"groups":{"type":"array","items":{"$ref":"#/definitions/KeyValuePairBO"}},"id":{"type":"string","example":"f9ad04bc-cbfc-47bd-aaa2-78ed27925018"},"name":{"type":"string","example":"All app bundle"}},"title":"BundleDetails"},"BundlesDTO":{"type":"object","properties":{"bundlesList":{"type":"array","items":{"$ref":"#/definitions/BundleDetails"}}},"title":"BundlesDTO"},"CloudAppPool":{"type":"object","properties":{"cloudAppPools":{"type":"array","items":{"$ref":"#/definitions/CloudAppPoolDetails"}}},"title":"CloudAppPool"},"CloudAppPoolDetails":{"type":"object","properties":{"cloudProvider":{"type":"string","example":"Azure Cloud"},"description":{"type":"string","example":"CloudApp test pool"},"hostCount":{"type":"integer","format":"int32","example":25},"id":{"type":"string","example":"f9ad04bc-cbfc-47bd-aaa2-78ed27925018"},"name":{"type":"string","example":"HSKUForBusiness"},"region":{"type":"string","example":"India-Central"},"status":{"type":"string","example":"Success"},"template":{"type":"string","example":"TQaRDR1903-0812"},"vmType":{"type":"string","example":"BUSINESS_VM"},"zone":{"type":"string","example":"India-Central-A"}},"title":"CloudAppPoolDetails"},"CloudAppServerDetails":{"type":"object","properties":{"fqdn":{"type":"string","example":"dvcrdperf09-002.indevqa.ws"},"id":{"type":"string","example":"f9ad04bc-cbfc-47bd-aaa2-78ed27925018"},"ipAddress":{"type":"string","example":"10.60.0.10"},"mode":{"type":"string","example":"Enabled"},"name":{"type":"string","example":"HSKUForBusiness"},"status":{"type":"string","example":"Ready"},"totalSessions":{"type":"integer","format":"int32","example":17}},"title":"CloudAppServerDetails"},"CloudAppServers":{"type":"object","properties":{"cloudAppServers":{"type":"array","items":{"$ref":"#/definitions/CloudAppServerDetails"}}},"title":"CloudAppServers"},"CloudConfigSubscriptions":{"type":"object","properties":{"publicClouds":{"type":"array","items":{"$ref":"#/definitions/CloudDetails"}}},"title":"CloudConfigSubscriptions"},"CloudDetails":{"type":"object","properties":{"byoc":{"type":"boolean","example":true},"configType":{"type":"string","example":"Google Cloud Platform"},"name":{"type":"string","example":"Ent-Cloud"},"status":{"type":"string","example":"online"},"subscriptionId":{"type":"string","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxx5e58d"}},"title":"CloudDetails"},"CloudImages":{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/definitions/Images"}}},"title":"CloudImages"},"Clusters":{"type":"object","properties":{"clusters":{"type":"array","items":{"$ref":"#/definitions/GWClusterDetails"}}},"title":"Clusters"},"Cost Center to Assign":{"type":"object","properties":{"costCenter":{"type":"string","example":1105,"description":"cost center to assign"}},"title":"Cost Center to Assign"},"CreateBundleRequestDTO":{"type":"object","properties":{"appIds":{"type":"array","example":["f9ad04bc-cbfc-47bd-aaa2-78ed27925018"],"items":{"type":"string"}},"bundleName":{"type":"string","example":"App Bundle"}},"title":"CreateBundleRequestDTO"},"CreateCloudAppPool":{"type":"object","properties":{"autoCreateOnDelete":{"type":"boolean","example":false},"description":{"type":"string","example":"Sample description"},"loadBalancingMethod":{"type":"string","example":"Depth"},"maxSessionLimit":{"type":"integer","format":"int32","example":5},"pauseOnFirstFailure":{"type":"boolean","example":false},"poolName":{"type":"string","example":"Pool1"},"poolSize":{"type":"integer","format":"int32","example":2},"referencePool":{"type":"string","example":"a066da91-0191-46d2-83b1-8cd25f160fcc"},"serverNamePrefix":{"type":"string","example":"prefix"}},"title":"CreateCloudAppPool"},"CreateCloudAppRequest":{"type":"object","properties":{"appIconName":{"type":"string","example":"predefined1.png"},"appParams":{"type":"string","example":"TBD"},"applicationType":{"type":"string","example":"Cloud Application"},"bundles":{"type":"array","example":["f9ad04bc-cbfc-47bd-aaa2-78ed27925018"],"items":{"type":"string"}},"cloudAppType":{"type":"string","example":"Custom"},"fullPath":{"type":"string","example":"C:\\Program Files\\Programs\\program.exe"},"gatewayClusterId":{"type":"string","example":"f9ad04bc-cbfc-47bd-aaa2-78ed27925018"},"loginDomain":{"type":"string","example":"domain"},"loginOption":{"type":"string","example":"SSO_DOMAIN_USER_PASSWD"},"name":{"type":"string","example":"Graphics app"},"poolId":{"type":"string","example":"f9ad04bc-cbfc-47bd-aaa2-78ed27925018"},"routeThroughGateway":{"type":"string","example":"Always"},"serverType":{"type":"string","example":"Workspot Cloud App Pools"},"targetPlatforms":{"type":"array","example":["iOS", "Windows", "Android", "OSX"],"items":{"type":"string"}},"workingDir":{"type":"string","example":"C:\\Documents\\My Data"}},"title":"CreateCloudAppRequest"},"CreateCustomDesktop":{"type":"object","properties":{"biosGUID":{"type":"string","example":"12345678-1234-5678-ABCD-1234567890AB"},"computerName":{"type":"string","example":"Example-Dev"},"fqdn":{"type":"string","example":"name-xyx.domain.com"},"macAddress":{"type":"string","example":"00:1s:99:f1:d2:4f"}},"title":"CreateCustomDesktop"},"CreateDesktop":{"type":"object","properties":{"computerName":{"type":"string","example":"Example-Dev"},"domainOU":{"type":"string","example":"OU=WSVDI,DC=indevqa,DC=ws","description":"Domain OU"},"domainPWD":{"type":"string","example":"pswrd*","description":"Password for Domain Join"},"domainToJoin":{"type":"string","example":"indevqa.ws","description":"Domain name"},"domainUser":{"type":"string","example":"indevqa.ws\\johns","description":"Username"},"snapshotId":{"type":"string","example":"snap-06fb57fa7342bb456"}},"title":"CreateDesktop"},"CreateDesktopPoolRequest":{"type":"object","properties":{"allowUserRebootVM":{"type":"boolean","example":false},"autoCreateOnDelete":{"type":"boolean","example":false},"description":{"type":"string","example":"description"},"desktopNamePrefix":{"type":"string","example":"eupool"},"desktopNameSuffixLength":{"type":"integer","format":"int32","example":"1 or 2 or 3 or 4  (Number will be added to desktopPrefixName like eupool-001)"},"diskClass":{"type":"string","example":"StandardSSD"},"diskSize":{"type":"integer","format":"int32","example":"128 or 256 or 512 or 1024 or 2048 etc"},"displayName":{"type":"string","example":"Pool DisplayName"},"enableSelfServiceDiagnostics":{"type":"boolean","example":false},"gatewayClusterName":{"type":"string","example":"Public cloud Gateway ClusterName"},"gatewayType":{"type":"string","example":"GATEWAY_CLUSTER"},"isMultiZoneActive":{"type":"boolean","example":false},"loginDomain":{"type":"string","example":"domain Name if LoginType is SSO_USER_PASSWD"},"loginType":{"type":"string","example":"SSO_AAD or  SSO_USER_PASSWD or SSO_DOMAIN_USER_PASSWD or SSO_PREFILLED_DOMAIN_USERNAME"},"maintenancePolicy":{"type":"string","example":"maintanance Policy Name (from the GET /v1.0/policies?type=Maintenance command)"},"mediaRedirectionPolicy":{"type":"string","example":"Media RedirectionPolicy Name (from the GET /v1.0/policies?type=MediaRedirection command)"},"numberOfDesktops":{"type":"integer","format":"int32","example":1},"pauseOnFirstFailure":{"type":"boolean","example":false},"poolName":{"type":"string","example":"EU Desktop Pool"},"protocolPolicy":{"type":"string","example":"Protocol Policy Name (from the GET /v1.0/policies?type=Protocol command)"},"protocolPolicyOnCompanyNetwork":{"type":"string","example":"Protocol Policy on Company Network (from the GET /v1.0/policies?type=Protocol command)"},"referencePoolName":{"type":"string","example":"pool name"},"routeThroughGatewayType":{"type":"string","example":"Always OR Never"},"targetPlatforms":{"type":"array","example":["Windows", "OSX", "Linux", "WebApp", "Android", "iOS"],"items":{"type":"string"}},"timeLimitsPolicy":{"type":"string","example":"TimeLimits Policy Name (from the GET /v1.0/policies?type=TimeLimits command)"},"warmupPolicy":{"type":"string","example":"Warmup policy Name (from the GET /v1.0/policies?type=Warmup command)"},"windowsHelloEnabled":{"type":"boolean"}},"title":"CreateDesktopPoolRequest"},"CreateDesktopPoolResponse":{"type":"object","properties":{"desktopPoolId":{"type":"string","example":"poolId"},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"name":{"type":"string","example":"pool name"},"status":{"type":"string","example":"Succedded or Failure"}},"title":"CreateDesktopPoolResponse"},"CustomDesktopDTO":{"type":"object","properties":{"biosGUID":{"type":"string","example":"12345678-1234-5678-ABCD-1234567890AB"},"computerName":{"type":"string","example":"Example-Dev"},"fqdn":{"type":"string","example":"name-xyx.domain.com"},"id":{"type":"string","example":"63c1a03f-f5f6-4c1c-8373-f74238aa053c"}},"title":"CustomDesktopDTO"},"CustomImageResponse":{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/definitions/TemplateCustomImageBO"}}},"title":"CustomImageResponse"},"DeleteStaleDeviceRequest":{"type":"object","properties":{"deviceIds":{"type":"array","example":[550e8400-e29b-41d4-a716-446655440003, 550e8400-e29b-41d4-a716-446655440007],"items":{"type":"string"}}},"title":"DeleteStaleDeviceRequest"},"Desktop":{"type":"object","properties":{"email":{"type":"string","example":"devqa@example.com"},"fqdn":{"type":"string","example":"QASKP1-001.example.com"},"id":{"type":"string","example":"ee614d15-d671-44c4-9a26-b10eda000018"},"ipAddress":{"type":"string","example":"10.76.0.14"},"name":{"type":"string","example":"Test Desktop-001"},"poolId":{"type":"string","example":"ba3b630e-7157-471f-8b98-fa5d9c11e031"},"poolName":{"type":"string","example":"Persistent test pool"},"status":{"type":"string","example":"Ready"},"tags":{"type":"array","items":{"$ref":"#/definitions/Tag"}}},"title":"Desktop"},"Desktop to Assign":{"type":"object","properties":{"desktopId":{"type":"string","example":"73dc410b-6b13-40c6-32sd-32d4c175117c","description":"Id of desktop to assign"}},"title":"Desktop to Assign"},"DesktopList":{"type":"object","properties":{"desktops":{"type":"array","items":{"$ref":"#/definitions/Desktop"}}},"title":"DesktopList"},"DesktopPoolDetails":{"type":"object","properties":{"active":{"type":"boolean"},"availCount":{"type":"integer","format":"int32","example":10},"cloud":{"type":"string","example":"Azure Cloud"},"createDesktopOnDelete":{"type":"boolean"},"description":{"type":"string","example":"Persistent test pool"},"diskSize":{"type":"integer","format":"int32","example":"128 (in terms of GB)"},"drType":{"type":"string","example":"RDR"},"id":{"type":"string","example":"f9ad04bc-cbfc-47bd-aaa2-78ed27925018"},"name":{"type":"string","example":"HSKUForBusiness"},"nodeGroupName":{"type":"string","example":"grp-mixed-n2-1-8-me-west1-b"},"poolType":{"type":"string","example":"Persistent"},"rdGateways":{"type":"array","example":[rdgw1, rdgw2],"items":{"type":"string"}},"region":{"type":"string","example":"me-west1"},"routeGatewayType":{"type":"string","example":"Always"},"routeThruVPN":{"type":"boolean"},"status":{"type":"string","example":"Success"},"subscriptionName":{"type":"string","example":"Ent-Cloud"},"template":{"type":"string","example":"TQaRDR1903-0812"},"usedCount":{"type":"integer","format":"int32","example":25},"vmType":{"type":"string","example":"BUSINESS_VM"},"zone":{"type":"string","example":"me-west1-a"}},"title":"DesktopPoolDetails"},"ErrorInfo":{"type":"object","properties":{"description":{"type":"string","example":"null"},"error":{"type":"string","example":"null"}},"title":"ErrorInfo"},"GWAddGwHost":{"type":"object","properties":{"domainToJoin":{"$ref":"#/definitions/GWDomainToJoin"},"localAdmin":{"$ref":"#/definitions/GWHostLocalAdmin"}},"title":"GWAddGwHost"},"GWClusterActionResponse":{"type":"object","properties":{"clusterName":{"type":"string","example":"cluster Name"},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"status":{"type":"string","example":"Succeeded or Failed"}},"title":"GWClusterActionResponse"},"GWClusterDetails":{"type":"object","properties":{"authType":{"type":"string","example":"AAD"},"clusterId":{"type":"string","example":"df4799d5-3b46-4b24-bfb5-9f1442bfd651"},"description":{"type":"string","example":"This cluster is for accessing pools in Europe"},"imageName":{"type":"string","example":"Windows Server (2025)"},"name":{"type":"string","example":"EuropePoolAccess"},"policyName":{"type":"string","example":"Gateway Policy"},"publicDomain":{"type":"string","example":"example.com"},"publicDomainOverriden":{"type":"boolean"},"regionalClusters":{"type":"array","items":{"$ref":"#/definitions/GWRegionalClusterDetails"}},"subscriptionName":{"type":"string","example":"Ent-Cloud"},"vmClassName":{"type":"string","example":"Standard Gateway"}},"title":"GWClusterDetails"},"GWClusterHostConnectionDetails":{"type":"object","properties":{"activeConnections":{"type":"integer","format":"int64","example":1},"averageRequestAuthSeconds":{"type":"integer","format":"int64","example":2},"connections":{"type":"array","items":{"$ref":"#/definitions/GWClusterHostSessionDetails"}}},"title":"GWClusterHostConnectionDetails"},"GWClusterHostDetails":{"type":"object","properties":{"activeConnections":{"type":"integer","format":"int32","example":205},"agentVersion":{"type":"string","example":"1.5.0(548)"},"averageRequestAuthSeconds":{"type":"integer","format":"int64","example":1},"certExpiration":{"type":"string","example":"07/09/2021"},"certName":{"type":"string","example":"C=US, S=ca, L=Campbell, O=\"Example, Inc.\", OU=Example Unit, CN=*.example.com"},"cloudType":{"type":"string","example":"Azure Cloud"},"clusterRegionId":{"type":"string","example":"7731e815-099c-4b2b-82f5-2eeec2b16d6a"},"dns":{"type":"string","example":"Dev-inc-gw01.centralindia.cloudapp.azure.com"},"fqdn":{"type":"string","example":"Dev-inc-gw01.example.com"},"id":{"type":"string","example":"0438e503-a62d-4f20-9082-26dcf42237ca"},"lastRebootDate":{"type":"integer","format":"int64","example":1653395963398},"mode":{"type":"string","example":"Enabled"},"name":{"type":"string","example":"Dev-inc-gw001"},"osVersion":{"type":"string","example":"Microsoft Windows Server 2016 Datacenter 10.0.14393"},"privateIpAddress":{"type":"string","example":"10.60.0.54"},"publicIpAddress":{"type":"string","example":"52.172.133.239"},"region":{"type":"string","example":"INDIA_CENTRAL"},"status":{"type":"string","example":"Ready"},"statusReason":{"type":"string","example":"Agent offline"},"uri":{"type":"string","example":"Dev-inc-gw01-b701c8c6-d40f-492e-a6fd-b5131907466d.example.com"}},"title":"GWClusterHostDetails"},"GWClusterHostPerformanceDetails":{"type":"object","properties":{"cpu":{"type":"array","items":{"$ref":"#/definitions/GWClusterHostPerformanceSample"}},"memory":{"type":"array","items":{"$ref":"#/definitions/GWClusterHostPerformanceSample"}}},"title":"GWClusterHostPerformanceDetails"},"GWClusterHostPerformanceSample":{"type":"object","properties":{"timestamp":{"type":"string","example":1653395963398},"value":{"type":"string","example":11}},"title":"GWClusterHostPerformanceSample"},"GWClusterHostSessionDetails":{"type":"object","properties":{"clientIPAddress":{"type":"string","example":"xxx.xxx.xxx.xxx"},"connectedOn":{"type":"string","example":"05/18/2022 01:04:27"},"duration":{"type":"string","example":"03:53:15"},"idleTime":{"type":"string","example":"00:00:43"},"targetComputer":{"type":"string","example":"xxx.xxx.xxx.xxx"},"targetPort":{"type":"integer","format":"int64","example":3389},"transport":{"type":"string","example":"HTTP"},"userName":{"type":"string","example":"xxx.com\\userxxx"}},"title":"GWClusterHostSessionDetails"},"GWCreateCluster":{"type":"object","properties":{"authType":{"type":"string","example":"AAD or AD or IDP name"},"description":{"type":"string","example":"This cluster is for accessing pools in Europe"},"domainToJoin":{"$ref":"#/definitions/GWDomainToJoin"},"gatewayPolicyName":{"type":"string","example":"Gateway Policy (from the GET /v1.0/policies?type=Gateway command)"},"imageName":{"type":"string","example":"Windows Server (2025) (from the GET /v1.0/clouds/rdgateways/images command)"},"localAdmin":{"$ref":"#/definitions/GWHostLocalAdmin"},"name":{"type":"string","example":"EuropeGW"},"namePrefix":{"type":"string","example":"gw"},"npsServers":{"type":"array","items":{"$ref":"#/definitions/NpsServerBO"}},"numberOfHosts":{"type":"integer","format":"int32","example":3},"overridePublicDomain":{"type":"boolean","example":false},"publicDomain":{"type":"string","example":"example.com"},"region":{"type":"string","example":"us-east-1"},"resourceGroup":{"type":"string","example":"Local-RG (Required for Azure Cloud, not mandatory for GCP,AWS)"},"securityGroupId":{"type":"string","example":"sg-xxxxxxxxxx"},"subscriptionName":{"type":"string","example":"The subscription name from the GET /v1.0/clouds command"},"virtualNetworkId":{"type":"string","example":"https://www.googleapis.com/compute/v1/projects/project-name/global/networks/networkName"},"vmClassName":{"type":"string","example":"Standard Gateway (from the GET /v1.0/clouds/rdgateways/vmClasses command)"},"zone":{"type":"string","example":"asia"}},"title":"GWCreateCluster"},"GWDomainToJoin":{"type":"object","properties":{"domain":{"type":"string","example":"Domain"},"domainName":{"type":"string","example":"Domain to Join"},"domainOU":{"type":"string","example":"Domain OU"},"password":{"type":"string","example":"Password"},"userName":{"type":"string","example":"Username"}},"title":"GWDomainToJoin"},"GWDomainToJoinBO":{"type":"object","properties":{"domain":{"type":"string","example":"domain"},"domainName":{"type":"string","example":"domainName"},"domainOU":{"type":"string","example":"domain OU"},"password":{"type":"string","example":"password"},"userName":{"type":"string","example":"admin"}},"title":"GWDomainToJoinBO"},"GWHostLocalAdmin":{"type":"object","properties":{"password":{"type":"string","example":"abcd"},"userName":{"type":"string","example":"localadmin"}},"title":"GWHostLocalAdmin"},"GWPool":{"type":"object","properties":{"appId":{"type":"string","example":"c673e235-bff2-476a-b042-a13291c362f7"},"appName":{"type":"string","example":"RD1908-WordPad"},"id":{"type":"string","example":"6f007f1b-232d-477f-9d10-02b0035734d7"},"name":{"type":"string","example":"My persistent pool"},"poolType":{"type":"string","example":"VDI"}},"title":"GWPool"},"GWRegionalClusterDetails":{"type":"object","properties":{"availability":{"type":"string","example":"Highly Available"},"cloudType":{"type":"string","example":"Azure Cloud"},"clusterRegionId":{"type":"string","example":"23cd6b59-2b97-44ae-b32c-b341a7bc60d7"},"pools":{"type":"array","items":{"$ref":"#/definitions/GWPool"}},"region":{"type":"string","example":"NORTH_EUROPE"},"securityGroupId":{"type":"string","example":"sg-0c733xxxxx","description":"Applicable for AWS Clusters"},"securityGroupName":{"type":"string","example":"xxxxxxxxxxxxxx","description":"Applicable for AWS Clusters"},"status":{"type":"string","example":"Published"},"zone":{"type":"string","example":"us-central1-a","description":"Applicable for GCP Clusters"}},"title":"GWRegionalClusterDetails"},"GWUpdateCluster":{"type":"object","properties":{"gatewayPolicyName":{"type":"string","example":"gatewayPolicy Name"},"imageName":{"type":"string","example":"Windows Server (2025)"},"npsServers":{"type":"array","items":{"$ref":"#/definitions/NpsServerBO"}},"vmClassName":{"type":"string","example":"Standard Gateway"}},"title":"GWUpdateCluster"},"GWUpdateClusterResponse":{"type":"object","properties":{"clusterName":{"type":"string","example":"Cluster Name"},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"status":{"type":"string","example":"Succeeded or Failed"}},"title":"GWUpdateClusterResponse"},"GetLoginOptionsResponse":{"type":"object","properties":{"loginOptions":{"type":"array","example":[{"name":"SSO_USER_PASSWD"},{"name":"SSO_DOMAIN_USER_PASSWD"},{"name":"SSO_PREFILLED_DOMAIN_USERNAME"}],"items":{"$ref":"#/definitions/NameResponse"}}},"title":"GetLoginOptionsResponse"},"GetPoliciesResponse":{"type":"object","properties":{"policies":{"type":"array","items":{"$ref":"#/definitions/NameResponse"}},"policyType":{"type":"string"}},"title":"GetPoliciesResponse"},"GlobalDesktopBO":{"type":"object","properties":{"assignedPools":{"type":"array","items":{"$ref":"#/definitions/GlobalDesktopPool"}},"globalDesktopId":{"type":"string","example":"ee614d15-d671-44c4-9a26-b10eda000018"},"globalDesktopName":{"type":"string","example":"Global Desktop US"},"groupsAssigned":{"type":"array","items":{"$ref":"#/definitions/GroupDetailBO"}}},"title":"GlobalDesktopBO"},"GlobalDesktopDetailsBO":{"type":"object","properties":{"id":{"type":"string","example":"ee614d15-d671-44c4-9a26-b10eda000018"},"name":{"type":"string","example":"Test Pool Group"}},"title":"GlobalDesktopDetailsBO"},"GlobalDesktopId":{"type":"object","properties":{"globalDesktopId":{"type":"string","example":"1dbf8fc6-eea5-49fa-b142-90872b61c794"}},"title":"GlobalDesktopId"},"GlobalDesktopListBO":{"type":"object","properties":{"globalDesktopDetails":{"type":"array","items":{"$ref":"#/definitions/GlobalDesktopDetailsBO"}}},"title":"GlobalDesktopListBO"},"GlobalDesktopPool":{"type":"object","properties":{"poolDisplayName":{"type":"string","example":"HSKU For Business"},"poolId":{"type":"string","example":"832f0789-e5f5-4f17-9384-3287bec1ba44"},"poolName":{"type":"string","example":"HSKUForBusiness"},"precedence":{"type":"integer","format":"int32","example":1}},"title":"GlobalDesktopPool"},"GlobalDesktopPoolsList":{"type":"object","properties":{"assignedPools":{"type":"array","items":{"$ref":"#/definitions/GlobalDesktopPool"}},"id":{"type":"string","example":"70587aa0-8e10-42b1-b6ce-4929bca98c05"},"name":{"type":"string","example":"Global Desktop EU"}},"title":"GlobalDesktopPoolsList"},"GlobalDesktopsList":{"type":"object","properties":{"globalDesktops":{"type":"array","items":{"$ref":"#/definitions/GlobalDesktopPoolsList"}},"id":{"type":"string","example":"ee614d15-d671-44c4-9a26-b10eda000018"},"name":{"type":"string","example":"Domain Users"}},"title":"GlobalDesktopsList"},"GroupDetailBO":{"type":"object","properties":{"id":{"type":"string","example":"322408eb-7172-49a5-b2a9-da3cfd873f08"},"name":{"type":"string","example":"Domain Users"},"type":{"type":"string","example":"Workspot"}},"title":"GroupDetailBO"},"GroupsList":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/definitions/GroupDetailBO"}}},"title":"GroupsList"},"Hosts":{"type":"object","properties":{"rdGateways":{"type":"array","items":{"$ref":"#/definitions/GWClusterHostDetails"}}},"title":"Hosts"},"HydrateDuration":{"type":"object","properties":{"duration":{"type":"string","example":"5/Any Integer"}},"title":"HydrateDuration"},"Images":{"type":"object","properties":{"name":{"type":"string","example":"Windows Server (2025)"}},"title":"Images"},"KeyValuePairBO":{"type":"object","properties":{"id":{"type":"string","example":"e8ad04bc-cbfc-47bd-bcd2-78ed27925018"},"name":{"type":"string","example":"Workspot"}},"title":"KeyValuePairBO"},"License":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/definitions/LicenseDetails"}}},"title":"License"},"LicenseDetails":{"type":"object","properties":{"concurrentUsersAvailable":{"type":"integer","format":"int32","example":50},"concurrentUsersEntitlement":{"type":"integer","format":"int32","example":150},"drUsersAvailable":{"type":"integer","format":"int32","example":50},"drUsersEntitlement":{"type":"integer","format":"int32","example":90},"namedUsersAvailable":{"type":"integer","format":"int32","example":250},"namedUsersEntitlement":{"type":"integer","format":"int32","example":550},"rdrUsersAvailable":{"type":"integer","format":"int32","example":50},"rdrUsersEntitlement":{"type":"integer","format":"int32","example":100},"service":{"type":"string","example":"Cloud Desktop"},"vmBackupsAvailable":{"type":"integer","format":"int32","example":45},"vmBackupsEntitlement":{"type":"integer","format":"int32","example":50},"vmBackupsRetentionAvailable":{"type":"integer","format":"int32","example":25},"vmBackupsRetentionEntitlement":{"type":"integer","format":"int32","example":40},"vmType":{"type":"string","example":"STANDARD PREMIUM 128"}},"title":"LicenseDetails"},"MoveDesktopRequest":{"type":"object","required":["assignedUser","targetPoolId"],"properties":{"assignedUser":{"type":"string","example":"dsmith@example.com","description":"User's email address"},"targetPoolId":{"type":"string","example":"be95b637-b748-41f9-90ff-d3d55f4dd51d","description":"Target poolId to which desktop need to be moved."}},"title":"MoveDesktopRequest"},"NameResponse":{"type":"object","properties":{"name":{"type":"string"}},"title":"NameResponse"},"NpsServerBO":{"type":"object","properties":{"ipAddress":{"type":"string","example":"10.0.0.1"},"priority":{"type":"integer","format":"int32","example":1},"sharedSecret":{"type":"string","example":"secret key"}},"title":"NpsServerBO"},"OpResponse":{"type":"object","properties":{"details":{"type":"object","example":{"desktopName": "development-01","id": "ab6a8038-f86b-4bc2-aad7-d19a9975f5a9", "ipAddress": "10.60.2.74", "fqdn": "dev.example.com"}},"endTime":{"type":"string","example":"2020-09-04T05:28:28.968Z"},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"startTime":{"type":"string","example":"2020-09-04T05:24:22.113Z"},"status":{"type":"string","example":"Succeeded"}},"title":"OpResponse"},"Pool":{"type":"object","properties":{"desktopPools":{"type":"array","items":{"$ref":"#/definitions/DesktopPoolDetails"}}},"title":"Pool"},"Pool to Assign":{"type":"object","properties":{"poolId":{"type":"string","example":"73dc410b-6b13-40c6-32sd-32d4c175117c","description":"Id of pool to assign"}},"title":"Pool to Assign"},"Pool to Delete from GlobalDesktop":{"type":"object","properties":{"poolId":{"type":"string","example":"73dc410b-6b13-40c6-32sd-32d4c175117c","description":"Id of pool to delete"}},"title":"Pool to Delete from GlobalDesktop"},"PoolAgentTokenDetails":{"type":"object","properties":{"expireTime":{"type":"string","example":"Mon Sep 23, 2024 12:27:58"},"poolAgentToken":{"type":"string","example":"84beb52f4f6ed84e97f499550d32f55c9088b12d"}},"title":"PoolAgentTokenDetails"},"PoolPrecedenceDetails":{"type":"object","properties":{"poolId":{"type":"string","example":"1dbf8fc6-eea5-49fa-b142-90872b61c794"},"precedence":{"type":"integer","format":"int32","example":1}},"title":"PoolPrecedenceDetails"},"RefreshEntitlementsResponse":{"type":"object","properties":{"description":{"type":"string"}},"title":"RefreshEntitlementsResponse"},"Regions":{"type":"object","properties":{"regions":{"type":"array","example":[ "us-east-1", "ca-central-1", "us-west-2", "eu-west-1"],"items":{"type":"string"}}},"title":"Regions"},"RegisterTemplateRequestBO":{"type":"object","properties":{"name":{"type":"string","example":"template1"},"region":{"type":"string","example":"ap-south-1. Required for AWS clouds only."}},"title":"RegisterTemplateRequestBO"},"RemoteAssistDesktop":{"type":"object","required":["desktopId","password","poolId"],"properties":{"desktopId":{"type":"string","example":"be95b637-b748-41f9-90ff-d3d55f4dd51d","description":"Id of desktop to remote assist"},"password":{"type":"string","example":"password","description":"Password for initiating remote assist"},"poolId":{"type":"string","example":"3ce45fa5-be91-4a49-a297-c4e94eaf945d","description":"Id of pool"}},"title":"RemoteAssistDesktop"},"RemoteSessionDesktop":{"type":"object","required":["desktopId","poolId"],"properties":{"desktopId":{"type":"string","example":"6ca16b89-0077-447d-95d4-cf3f7e19c777","description":"Id of desktop with user session"},"poolId":{"type":"string","example":"8bb27ac0-b3ce-455b-8a30-3aed537fd45f","description":"Id of pool"}},"title":"RemoteSessionDesktop"},"RemoteSessionDesktopMessage":{"type":"object","required":["desktopId","displayDuration","message","poolId"],"properties":{"desktopId":{"type":"string","example":"be95b637-b748-41f9-90ff-d3d55f4dd51d","description":"DesktopId of a desktop belonging to the user."},"displayDuration":{"type":"integer","format":"int32","example":90,"description":"How long to display the message, in seconds."},"message":{"type":"string","example":"Please save your work. Your desktop will be shut down at 0320 UTC.","description":"Message string to display. Valid range: 1-250 characters "},"poolId":{"type":"string","example":"eba2f3fa-be97-4403-8f00-4895cbc13ab3","description":"Id of pool"}},"title":"RemoteSessionDesktopMessage"},"SecurityGroup":{"type":"object","properties":{"id":{"type":"string","example":"sg-xxxxxxxxxxxxxxxxx"},"name":{"type":"string","example":"securityGroupName"},"vpcId":{"type":"string","example":"vpc-xxxxxxxxxxxxxxxxx"}},"title":"SecurityGroup"},"SecurityGroups":{"type":"object","properties":{"securityGroups":{"type":"array","items":{"$ref":"#/definitions/SecurityGroup"}}},"title":"SecurityGroups"},"StaleDevice":{"type":"object","properties":{"controlDetectedDtm":{"type":"string","format":"date-time","example":"2024-09-29 11:00:00.0"},"desktopDeletedDtm":{"type":"string","format":"date-time","example":"2024-09-23 11:00:00.0"},"desktopId":{"type":"string","example":"22ff14b9-c4c0-494a-99a9-37a5e505d661"},"desktopName":{"type":"string","example":"workspotVDI-001"},"deviceId":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440087"},"deviceName":{"type":"string","example":"workspot-device"},"entraDeviceId":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440084"},"entraObjectId":{"type":"string","example":"660e8400-e29b-41d4-a716-446655440065"},"intuneDeviceId":{"type":"string","example":"770e8400-e29b-41d4-a716-446655440077"},"poolId":{"type":"string","example":"bede4cc4-576c-42dd-83d0-b326d0e7029a"},"poolName":{"type":"string","example":"workspotVDI"}},"title":"StaleDevice"},"StaleDevices":{"type":"object","properties":{"currentPage":{"type":"integer","format":"int32"},"devices":{"type":"array","items":{"$ref":"#/definitions/StaleDevice"}},"totalCount":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"title":"StaleDevices"},"Tag":{"type":"object","properties":{"name":{"type":"string","example":"Engineering"},"value":{"type":"string","example":"Development"}},"title":"Tag"},"TagDesktopRequest":{"type":"object","properties":{"desktopId":{"type":"string","example":"1dbf8fc6-eea5-49fa-b142-90872b61c794"},"poolId":{"type":"string","example":"eba2f3fa-be97-4403-8f00-4895cbc13ab3"},"tags":{"type":"array","items":{"$ref":"#/definitions/Tag"}}},"title":"TagDesktopRequest"},"TemplateCustomImageBO":{"type":"object","properties":{"imageName":{"type":"string","example":"base-win11"},"imageType":{"type":"string","example":"Windows Server"},"region":{"type":"string","example":"us-east-1"}},"title":"TemplateCustomImageBO"},"TemplateVMClass":{"type":"object","properties":{"cpu":{"type":"integer","format":"int32","example":2},"diskSize":{"type":"integer","format":"int32","example":128},"gpu":{"type":"boolean","example":false},"memory":{"type":"integer","format":"int64","example":8},"name":{"type":"string","example":"Standard VM"},"vmInstances":{"type":"string","example":"n1-standard-2"}},"title":"TemplateVMClass"},"TemplateVmClasses":{"type":"object","properties":{"vmClasses":{"type":"array","items":{"$ref":"#/definitions/TemplateVMClass"}}},"title":"TemplateVmClasses"},"UpdateCloudAppPool":{"type":"object","properties":{"autoCreateOnDelete":{"type":"boolean","example":false},"description":{"type":"string","example":"Sample description"},"loadBalancingMethod":{"type":"string","example":"Depth"},"maxSessionLimit":{"type":"integer","format":"int32","example":5},"poolSize":{"type":"integer","format":"int32","example":2}},"title":"UpdateCloudAppPool"},"UpdateCloudAppRequest":{"type":"object","properties":{"appIconName":{"type":"string","example":"predefined1.png"},"appParams":{"type":"string","example":"TBD"},"bundles":{"type":"array","example":["f9ad04bc-cbfc-47bd-aaa2-78ed27925018"],"items":{"type":"string"}},"fullPath":{"type":"string","example":"C:\\Program Files\\Programs\\program.exe"},"gatewayClusterId":{"type":"string","example":"f9ad04bc-cbfc-47bd-aaa2-78ed27925018"},"loginDomain":{"type":"string","example":"domain"},"loginOption":{"type":"string","example":"SSO_DOMAIN_USER_PASSWD"},"name":{"type":"string","example":"Graphics app"},"routeThroughGateway":{"type":"string","example":"Always"},"targetPlatforms":{"type":"array","example":["iOS", "Windows", "Android", "OSX"],"items":{"type":"string"}},"useDefaultIcon":{"type":"boolean","example":false,"description":"Set to true to switch the application to the default icon. Cannot be combined with appIconName."},"workingDir":{"type":"string","example":"C:\\Documents\\My Data"}},"title":"UpdateCloudAppRequest"},"UpdateDesktopPoolRequest":{"type":"object","properties":{"allowUserRebootVM":{"type":"boolean","example":false},"autoCreateOnDelete":{"type":"boolean","example":false},"description":{"type":"string","example":"description"},"displayName":{"type":"string","example":"Pool DisplayName"},"enableSelfServiceDiagnostics":{"type":"boolean","example":false},"gatewayClusterName":{"type":"string","example":"Public cloud Gateway ClusterName"},"gatewayType":{"type":"string","example":"GATEWAY_CLUSTER"},"isMultiZoneActive":{"type":"boolean","example":false},"loginDomain":{"type":"string","example":"domain Name if LoginType is SSO_USER_PASSWD"},"loginType":{"type":"string","example":"SSO_AAD or  SSO_USER_PASSWD or SSO_DOMAIN_USER_PASSWD or SSO_PREFILLED_DOMAIN_USERNAME"},"maintenancePolicy":{"type":"string","example":"Maintenance Policy Name. Set to null to  remove the Maintenance Policy."},"mediaRedirectionPolicy":{"type":"string","example":"Media RedirectionPolicy Name. Set to null to  remove the Media redirection Policy."},"numberOfDesktops":{"type":"integer","format":"int32","example":1},"pauseOnFirstFailure":{"type":"boolean","example":false},"protocolPolicy":{"type":"string","example":"Protocol Policy Name. Set to null to  remove the protocol policy."},"protocolPolicyOnCompanyNetwork":{"type":"string","example":"Protocol Policy on Company Network. Set to null to  remove the protocol policy on company network."},"routeThroughGatewayType":{"type":"string","example":"Always OR Never"},"targetPlatforms":{"type":"array","example":["Windows", "OSX", "Linux", "WebApp", "Android", "iOS"],"items":{"type":"string"}},"timeLimitsPolicy":{"type":"string","example":"TimeLimits Policy Name. Set to null to  remove the time limits policy."},"warmupPolicy":{"type":"string","example":"Warmup Policy Name. Set to null to  remove the warmup Policy."},"windowsHelloEnabled":{"type":"boolean","example":false}},"title":"UpdateDesktopPoolRequest"},"UpgradeDesktopRequest":{"type":"object","required":["domainOU","domainPWD","domainToJoin","domainUser","retainName","targetPoolId"],"properties":{"computerName":{"type":"string","example":"Example-123","description":"Optional, provide if you want to give a custom name to desktop in taget pool."},"domainOU":{"type":"string","example":"OU=WSVDI,DC=indevqa,DC=ws","description":"Domain OU"},"domainPWD":{"type":"string","example":"pswrd*","description":"Password for Domain Join,"},"domainToJoin":{"type":"string","example":"indevqa.ws","description":"Domain name"},"domainUser":{"type":"string","example":"indevqa.ws\\johns","description":"Username"},"retainName":{"type":"string","example":"false","description":"Flag to determine if old computer name should be retained for upgraded desktop or replaced with that of target pool"},"targetPoolId":{"type":"string","example":"be95b637-b748-41f9-90ff-d3d55f4dd51d","description":"Target poolId to which desktop need to be upgraded."}},"title":"UpgradeDesktopRequest"},"UsageReport":{"type":"object","properties":{"end":{"type":"string","example":"2018-09-14","description":"in YYYY-MM-DD format"},"format":{"type":"string","example":"JSON","description":"Report output format in either JSON or CSV; default is JSON","enum":["JSON","CSV"]},"start":{"type":"string","example":"2018-09-12","description":"in YYYY-MM-DD format"}},"title":"UsageReport"},"User":{"type":"object","properties":{"assignedDesktops":{"type":"array","items":{"$ref":"#/definitions/UserDesktop"}},"assignedPools":{"type":"array","items":{"$ref":"#/definitions/UserPool"}},"costCenter":{"type":"string","example":115},"email":{"type":"string","example":"dsmith@example.com"},"firstName":{"type":"string","example":"David"},"id":{"type":"string","example":"e17aa8fc-3919-4461-8345-bdd665e55fb8"},"lastName":{"type":"string","example":"Smith"}},"title":"User"},"UserDesktop":{"type":"object","properties":{"desktopIP":{"type":"string","example":"10.60.0.54"},"desktopName":{"type":"string","example":"Dev-desktop-001"},"id":{"type":"string","example":"2f102d72-8c58-460b-9dbf-c32d6a84f9f2"}},"title":"UserDesktop"},"UserGlobalDesktopPoolDetailsBO":{"type":"object","properties":{"assignedPools":{"type":"array","items":{"$ref":"#/definitions/AssignedPoolDesktopDetailsBO"}},"email":{"type":"string","example":"dsmith@example.com"},"firstName":{"type":"string","example":"David"},"globalDesktopId":{"type":"string","example":"cc652243-a14a-47c5-834a-54343b8fd817"},"globalDesktopName":{"type":"string","example":"Test Application"},"lastName":{"type":"string","example":"Smith"},"userId":{"type":"string","example":"e17aa8fc-3919-4461-8345-bdd665e55fb8"}},"title":"UserGlobalDesktopPoolDetailsBO"},"UserPool":{"type":"object","properties":{"active":{"type":"boolean"},"description":{"type":"string","example":"Technology persistent pool"},"drType":{"type":"string","example":"RDR"},"id":{"type":"string","example":"d8af1769-8aec-496c-9b7a-7ac6a32a8ee4"},"poolDisplayName":{"type":"string","example":"Pool to be used by Technology people"},"poolName":{"type":"string","example":"Pool for Technology"},"poolType":{"type":"string","example":"Persistent"}},"title":"UserPool"},"VDIPoolDetails":{"type":"object","properties":{"poolPrecedence":{"type":"array","items":{"$ref":"#/definitions/PoolPrecedenceDetails"}}},"title":"VDIPoolDetails"},"VMClass":{"type":"object","properties":{"name":{"type":"string","example":"Standard Gateway"},"vmInstances":{"type":"string","example":"n2-standard-4,n1-standard-4,n4-standard-4"}},"title":"VMClass"},"VMRetentionDetails":{"type":"object","properties":{"desktopId":{"type":"string","example":"ee614d15-d671-44c4-9a26-b10eda000018"},"desktopStatus":{"type":"string","example":"Online"},"retentionPeriod":{"type":"string","example":15}},"title":"VMRetentionDetails"},"VMRetentionPeriod":{"type":"object","properties":{"retentionPeriod":{"type":"string","example":12}},"title":"VMRetentionPeriod"},"VmClasses":{"type":"object","properties":{"vmClasses":{"type":"array","items":{"$ref":"#/definitions/VMClass"}}},"title":"VmClasses"},"Zones":{"type":"object","properties":{"zones":{"type":"array","example":[ "us-east1-b", "us-east1-c", "us-east1-d"],"items":{"type":"string"}}},"title":"Zones"}}}