Actions11
Manual Workstation
AI-generatedOverview
This node integrates with Google Cloud Workstations via the Google IDX API, enabling users to manage and interact with their cloud-based development workstations programmatically within n8n workflows. It supports a variety of operations such as starting, stopping, resetting, updating, and manually controlling workstations, as well as retrieving status information and generating access tokens.
Common scenarios include automating workstation lifecycle management, running commands remotely on workstations, monitoring workstation statuses, and integrating workstation control into CI/CD pipelines or developer tooling automation.
For example, a user can automate starting a specific workstation before a development session, run initialization scripts remotely, check if the workstation is running, and then stop it after work is done — all triggered from an n8n workflow.
Properties
| Name | Meaning |
|---|---|
| Project ID | Select or enter your Google Cloud project ID. Can be chosen from a list of projects or entered manually as a string. |
| WorkStation ID | The identifier string for the specific workstation to operate on. Used only in the "Manual Workstation" operation. |
| Is Global Data | Boolean flag indicating whether to use global workflow static data (true) or node-specific data (false). |
| Global Data | JSON object containing global data to be used when "Is Global Data" is set to true. |
Output
The node outputs an array of items where each item contains a json field with operation-specific data. The structure varies depending on the operation performed:
- For status queries, it returns workstation states grouped by status (starting, running, stopped).
- For manual commands, it outputs action details including user, workspace, and optionally the command executed.
- For token generation and other API calls, it returns the raw response JSON from the Google IDX API.
- For running shell commands via gcloud CLI inside Docker containers, it outputs execution metadata including timestamps, exit codes, stdout, stderr, and access tokens.
If binary data were involved, it would typically represent files or command output streams, but this node primarily deals with JSON responses and command execution results.
Dependencies
- Requires an OAuth2 API credential configured for Google IDX API access.
- Depends on the Google Cloud Workstations API endpoints.
- Uses the
gcloudCLI tool and Docker for executing remote commands in some operations. - Requires appropriate permissions on the Google Cloud project to manage workstations.
- Node environment must allow execution of child processes for running shell commands.
Troubleshooting
- Missing or invalid input errors: The "Manual Workstation" operation expects a specific command format. Ensure the input matches
/[run|start|stop|status|token] -a USER -ws SLUG[,SLUG2] [-c COMMAND]. Missing required parts like the-c COMMANDforrunactions will cause errors. - Authentication failures: Ensure the OAuth2 credentials are valid and have not expired. Re-authenticate if necessary.
- API request errors: Network issues or insufficient permissions may cause API calls to fail. Verify project permissions and network connectivity.
- Command execution errors: When running commands via Docker and gcloud CLI, ensure Docker is running, the container name is correct, and the gcloud CLI is installed and configured properly.
- Unsupported operations: Attempting to use an operation not implemented by the node will throw an error indicating unsupported operation.