Google IDX icon

Google IDX

Google IDX
Join our community

Actions10

Overview

This node integrates with Google Cloud Workstations via the Google IDX API, enabling management of workstation lifecycle and status within a Google Cloud project. The "Stop Workstation" operation specifically sends a request to stop a running workstation instance.

Common scenarios for this node include automating cloud development environment management, such as starting or stopping workstations on demand to save costs or enforce security policies. For example, a developer team can use it to programmatically stop idle workstations at the end of the day or after CI/CD pipeline runs.

Properties

Name Meaning
Project ID Select or enter your Google Cloud project ID where the workstation resides.

The "Project ID" property supports two modes:

  • From List: Choose from a list of available Google Cloud projects.
  • ID: Manually enter the project ID string.

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 operation's success or failure.

Example output JSON (simplified):

{
  "statusCode": 200,
  "data": {
    // details about the stopped workstation or operation result
  }
}

If the node is used in other operations, outputs may vary accordingly, but for "Stop Workstation," the key output is the confirmation or status of the stop request.

No binary data output is produced by this node.

Dependencies

  • Requires an OAuth2 API credential configured for Google IDX API access.
  • Needs network access to workstations.googleapis.com endpoints.
  • The node uses n8n's built-in OAuth2 helper methods to authenticate requests.
  • No additional external services beyond Google Cloud Workstations API are required.

Troubleshooting

  • Missing or invalid Project ID: Ensure the "Project ID" input is correctly set either by selecting from the list or entering a valid project identifier.
  • Authentication errors: Verify that the OAuth2 credentials have proper scopes and permissions to manage Google Cloud Workstations.
  • API rate limits or transient errors: The node implements retries for HTTP 503/504 errors; if failures persist, check Google Cloud quota and service status.
  • Unsupported operation error: This occurs if an operation outside the supported set is requested; confirm the operation name matches exactly "stopWorkstation".
  • Command execution errors: If using related commands (e.g., runCommandWorkstation), ensure all required parameters like project ID and command strings are provided.

Links and References

Discussion