Google IDX Live icon

Google IDX Live

Google IDX Live
Join our community

Actions7

Overview

This node interacts with Google IDX Live workspaces through a headless browser automation approach using Puppeteer. It supports multiple operations such as retrieving all workspaces, creating new workspaces, resetting or running commands in workspaces, and checking live status of devices. The node is useful for automating management and monitoring tasks related to Google IDX Live environments, especially when API endpoints are limited or unavailable.

Practical examples:

  • Fetching a list of all Google IDX Live workspaces associated with an account.
  • Creating a new workspace by specifying its name.
  • Resetting one or more workspaces programmatically.
  • Running terminal commands inside a workspace session.
  • Checking the live status of devices connected to a network.

Properties

Name Meaning
Options Collection of optional parameters to customize the operation.
- Browser WebSocket Endpoint A string URL to connect Puppeteer to an existing browser instance via WebSocket.

The node also expects credentials containing a profile and cookie for authentication but these are handled internally and not exposed as input properties.

Output

The output JSON structure varies depending on the selected operation:

  • Get All WorkSpaces (allWorkSpaces operation):

    • workspaces: An array of workspace objects each containing:
      • id: Workspace identifier.
      • name: Workspace name.
      • link: URL link to the workspace.
      • account: Associated account information.
    • profile: Profile information from credentials.

  • New WorkSpace (newWorkSpace operation):

    • Returns the created workspace name and profile info.

  • Reset WorkSpace (resetWorkSpace operation):

    • Returns arrays of workspace IDs, names, reset status, and timestamps.

  • Run WorkSpace (runWorkSpace operation):

    • Returns detailed info per workspace including id, name, url, token, account, profile, and optionally a screenshot image in binary form.

  • Run Command (runCommand operation):

    • Returns profile info after executing the command.

  • Check Live (checkLive operation):

    • Returns device status grouped by filters such as hostname prefix or IP prefix, with online/offline status and last seen timestamps.

  • Check Status (checkStatus operation):

    • Returns timestamped profile data indicating login status.

If screenshots are captured during operations (except runWorkSpace and resetWorkSpace), they are returned as binary data named image containing a PNG screenshot of the current page.

Dependencies

  • Requires an API key credential with profile and cookie information for Google IDX authentication.
  • Uses Puppeteer Extra with stealth plugin to automate Chromium browser interactions.
  • Optionally connects to an existing browser instance via a WebSocket endpoint if provided.
  • Network access to Google accounts and Google IDX URLs is required.
  • No external environment variables beyond the credential are explicitly needed.

Troubleshooting

  • Failed to launch/connect to browser: Ensure the WebSocket endpoint is correct and accessible, or that Puppeteer can launch a local browser.
  • Authentication errors: Verify that the provided credentials include valid profile and cookie data.
  • Timeouts or navigation failures: Network issues or changes in Google IDX web UI may cause selectors to fail; updating selectors or increasing wait times might help.
  • Screenshot capture errors: Errors like "detached frame" or "connection closed" indicate unstable browser sessions; retrying or reconnecting the browser may resolve this.
  • Operation-specific errors: For example, running commands requires proper workspace IDs and command strings; missing or invalid inputs will cause failures.

Links and References

Discussion