Google IDX icon

Google IDX

Google IDX

Stop Workstation

AI-generated

Overview

This node integrates with Google Cloud Workstations via the Google IDX API, enabling management and control of cloud-based development workstations. The "Stop Workstation" operation specifically allows users to stop a running workstation instance within their Google Cloud project.

Common scenarios for this node include automating workstation lifecycle management in CI/CD pipelines, remotely controlling developer environments, or integrating workstation state changes into broader workflows.

Practical example: A DevOps engineer can use this node to programmatically stop a workstation after automated tests complete, saving resources and costs by shutting down unused instances.

Properties

Name Meaning
Project ID Select or enter your Google Cloud project ID where the workstation resides.
Is Global Data Boolean flag indicating whether to use global workflow data storage for session info.
Global Data JSON object containing global data used when "Is Global Data" is true.

Output

The output JSON structure for the "Stop Workstation" operation contains the response from the Google IDX API after attempting to stop the workstation. It typically includes status information about the request, such as success confirmation or error details.

Example output JSON snippet:

{
  "json": {
    // API response fields indicating the result of the stop operation
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an OAuth2 API credential configured for Google IDX API access.
  • Needs proper permissions on the Google Cloud project to manage workstations.
  • The node uses the Google Workstations REST API endpoints under workstations.googleapis.com.
  • No additional environment variables are explicitly required beyond standard n8n OAuth2 credential setup.

Troubleshooting

  • Missing or invalid Project ID: Ensure the Project ID is correctly specified and accessible by the authenticated user.
  • Authentication errors: Verify that the OAuth2 credentials are valid and have not expired.
  • Unsupported operation error: This node only supports predefined operations; ensure "Stop Workstation" is selected.
  • API request failures: Network issues or insufficient permissions may cause API calls to fail. Check connectivity and IAM roles.
  • Global Data usage: If using global data storage, confirm the JSON structure is correct and consistent across executions.

Links and References

Discussion