Workspot Control REST API

{"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

# --- truncated at 32 KB (162 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/workspot/refs/heads/main/openapi/workspot-control-openapi-original.json