Cloud Workstations API
Allows administrators to create managed developer environments in the cloud.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Allows administrators to create managed developer environments in the cloud.
Endpoints 21
projects.locations.workstationClusters.workstationConfigs.workstations
- GETReturns the requested workstation.
/v1/:nameReturns the requested workstation. - DELETEDeletes the specified workstation.
/v1/:name?etag=string&validateOnly=trueDeletes the specified workstation. - PATCHUpdates an existing workstation.
/v1/:name?allowMissing=true&updateMask=string&validateOnly=trueUpdates an existing workstation. - GETGets the access control policy for a resource
/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - POSTSets the access control policy on the specified resource
/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - POSTReturns permissions that a caller has on the specified resource
/v1/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND… - GETReturns all Workstations using the specified workstation configuration.
/v1/:parent/workstations?filter=string&pageSize=0&pageToken=stringReturns all Workstations using the specified workstation configuration. - POSTCreates a new workstation.
/v1/:parent/workstations?validateOnly=true&workstationId=stringCreates a new workstation. - POSTReturns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation
/v1/:workstation:generateAccessTokenReturns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. Once generated this token cannot be revoked… - GETReturns all workstations using the specified workstation configuration on which the caller has the…
/v1/:parent/workstations:listUsable?pageSize=0&pageToken=stringReturns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission. - POSTStarts running a workstation so that users can connect to it.
/v1/:name:startStarts running a workstation so that users can connect to it. - POSTStops running a workstation, reducing costs.
/v1/:name:stopStops running a workstation, reducing costs. - POSTSuspends a workstation to reduce costs.
/v1/:name:suspendSuspends a workstation to reduce costs.
projects.locations
- GETLists information about the supported locations for this service
/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…
projects.locations.operations
- POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - GETLists operations that match the specified filter in the request
/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
projects.locations.workstationClusters
- GETReturns all workstation clusters in the specified location.
/v1/:parent/workstationClusters?filter=string&pageSize=0&pageToken=stringReturns all workstation clusters in the specified location. - POSTCreates a new workstation cluster.
/v1/:parent/workstationClusters?validateOnly=true&workstationClusterId=stringCreates a new workstation cluster.
projects.locations.workstationClusters.workstationConfigs
- GETReturns all workstation configurations in the specified cluster.
/v1/:parent/workstationConfigs?filter=string&pageSize=0&pageToken=stringReturns all workstation configurations in the specified cluster. - POSTCreates a new workstation configuration.
/v1/:parent/workstationConfigs?validateOnly=true&workstationConfigId=stringCreates a new workstation configuration. - GETReturns all workstation configurations in the specified cluster on which the caller has the…
/v1/:parent/workstationConfigs:listUsable?pageSize=0&pageToken=stringReturns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
API details
- Base URL
https://workstations.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 21 operations on 16 pathsPOST 10GET 9PATCH 1DELETE 1
- Main resources
- projects.locations.workstationClusters.workstationConfigs.w… 13projects.locations.workstationClusters.workstationConfigs 3projects.locations.operations 2projects.locations.workstationClusters 2projects.locations 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Workstations API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Workstations API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Returns the requested workstation.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Workstations API?
Allows administrators to create managed developer environments in the cloud. It is listed under Developer tools and has 21 endpoints.
Who publishes the Cloud Workstations API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud Workstations API?
Requests go to https://workstations.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Workstations API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Cloud Workstations API have?
21 operations on 16 paths (10 POST, 9 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.workstationClusters.workstationConfigs.w…, projects.locations.workstationClusters.workstationConfigs, projects.locations.operations, projects.locations.workstationClusters.
Is forking the Cloud Workstations API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.