# Cloud Workstations API API

> Cloud Workstations API API on Apizie: 21 endpoints (Returns the requested workstation., Updates an existing workstation., Deletes the specified workstation., Lists information about the supported locations for this service. This method lists locations based on the…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/analytics:googleapis-workstations/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-workstations`
- Category: Analytics
- Status: byok
- Source: https://cloud.google.com/workstations
- Page: https://zieapi.vercel.app/api/analytics/googleapis-workstations
- OpenAPI: https://zieapi.vercel.app/api/analytics/googleapis-workstations/openapi.json

Allows administrators to create managed developer environments in the cloud.

## Endpoints

### Returns the requested workstation.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. Name of the requested resource. |

### Updates an existing workstation.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| allowMissing | boolean | no | Optional. If set and the workstation is not found, a new workstation is created. In this situation, update_mask is ignored. |
| name | string | yes | Identifier. Full name of this workstation. |
| updateMask | string | no | Required. Mask specifying which fields in the workstation should be updated. |
| validateOnly | boolean | no | Optional. If set, validate the request and preview the result, but do not actually apply it. |
| body | object | yes | JSON request body |

### Deletes the specified workstation.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| etag | string | no | Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. |
| name | string | yes | Required. Name of the workstation to delete. |
| validateOnly | boolean | no | Optional. If set, validate the request and preview the result, but do not actually apply it. |

### Lists information about the supported locations for this service. This method lists locations based on the…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| extraLocationTypes | string | no | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter | string | no | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is… |
| name | string | yes | The resource that owns the locations collection, if applicable. |
| pageSize | integer | no | The maximum number of results to return. If not set, the service selects a default. |
| pageToken | string | no | A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |

### Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-operations-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource to be cancelled. |
| body | object | yes | JSON request body |

### Lists operations that match the specified filter in the request. If the server doesn't support this method,…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | The standard list filter. |
| name | string | yes | The name of the operation's parent resource. |
| pageSize | integer | no | The standard list page size. |
| pageToken | string | no | The standard list page token. |
| returnPartialSuccess | boolean | no | When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the… |

### Returns all workstation clusters in the specified location.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Filter the WorkstationClusters to be listed. Possible filters are described in https://google.aip.dev/160. |
| pageSize | integer | no | Optional. Maximum number of items to return. |
| pageToken | string | no | Optional. next_page_token value returned from a previous List request, if any. |
| parent | string | yes | Required. Parent resource name. |

### Creates a new workstation cluster.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Parent resource name. |
| validateOnly | boolean | no | Optional. If set, validate the request and preview the result, but do not actually apply it. |
| workstationClusterId | string | no | Required. ID to use for the workstation cluster. |
| body | object | yes | JSON request body |

### Returns all workstation configurations in the specified cluster.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Filter the WorkstationConfigs to be listed. Possible filters are described in https://google.aip.dev/160. |
| pageSize | integer | no | Optional. Maximum number of items to return. |
| pageToken | string | no | Optional. next_page_token value returned from a previous List request, if any. |
| parent | string | yes | Required. Parent resource name. |

### Creates a new workstation configuration.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-5` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Parent resource name. |
| validateOnly | boolean | no | Optional. If set, validate the request and preview the result, but do not actually apply it. |
| workstationConfigId | string | no | Required. ID to use for the workstation configuration. |
| body | object | yes | JSON request body |

### Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-6` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| options.requestedPolicyVersion | integer | no | Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid… |
| resource | string | yes | REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names)… |

### Returns all workstation configurations in the specified cluster on which the caller has the…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-7` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Optional. Maximum number of items to return. |
| pageToken | string | no | Optional. next_page_token value returned from a previous List request, if any. |
| parent | string | yes | Required. Parent resource name. |

### Sets the access control policy on the specified resource. Replaces any existing policy. Can return…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-8` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names)… |
| body | object | yes | JSON request body |

### Returns permissions that a caller has on the specified resource. If the resource does not exist, this will…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-9` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | REQUIRED: The resource for which the policy detail is being requested. See [Resource… |
| body | object | yes | JSON request body |

### Returns all Workstations using the specified workstation configuration.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-10` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Filter the Workstations to be listed. Possible filters are described in https://google.aip.dev/160. |
| pageSize | integer | no | Optional. Maximum number of items to return. |
| pageToken | string | no | Optional. next_page_token value returned from a previous List request, if any. |
| parent | string | yes | Required. Parent resource name. |

### Creates a new workstation.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-11` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Parent resource name. |
| validateOnly | boolean | no | Optional. If set, validate the request and preview the result, but do not actually apply it. |
| workstationId | string | no | Required. ID to use for the workstation. |
| body | object | yes | JSON request body |

### Returns a short-lived credential that can be used to send authenticated and authorized traffic to a…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-12` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workstation | string | yes | Required. Name of the workstation for which the access token should be generated. |
| body | object | yes | JSON request body |

### Returns all workstations using the specified workstation configuration on which the caller has the…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-13` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Optional. Maximum number of items to return. |
| pageToken | string | no | Optional. next_page_token value returned from a previous List request, if any. |
| parent | string | yes | Required. Parent resource name. |

### Starts running a workstation so that users can connect to it.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-14` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. Name of the workstation to start. |
| body | object | yes | JSON request body |

### Stops running a workstation, reducing costs.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-15` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. Name of the workstation to stop. |
| body | object | yes | JSON request body |

### Suspends a workstation to reduce costs.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta-16` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. Name of the workstation to suspend. |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Cloud Workstations API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/analytics:googleapis-workstations/workstations-projects-locations-workstation-clusters-worksta with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Cloud Workstations API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Cloud Workstations API itself also needs your own key from googleapis.com.

### Can AI agents use the Cloud Workstations API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-workstations.

### What is the status of the Cloud Workstations API API?
Needs your own provider key (bring your own key)
