Scrapybara icon

Scrapybara

Interact with the Scrapybara API
Join our community

Actions8

Overview

This node integrates with the Scrapybara API to manage virtual instances of different types, such as Ubuntu, Browser, and Windows. Specifically, the "Start" operation under the "Instance" resource allows users to start a new instance of a selected type with an optional timeout setting. This is useful for automating workflows that require temporary computing environments or browser sessions, such as automated testing, web scraping, or running isolated tasks.

For example, you can use this node to start an Ubuntu server instance that will automatically terminate after a specified number of hours, enabling ephemeral compute resources without manual cleanup.

Properties

Name Meaning
Instance Type The type of instance to start. Options: "Ubuntu" (start an Ubuntu instance), "Browser" (start a browser instance), "Windows" (start a Windows instance).
Timeout Hours Optional. Number of hours before the instance is automatically terminated. Default is 1 hour.

Output

The output JSON contains the details of the started instance as returned by the Scrapybara API client. It typically includes information such as instance ID, status, and other metadata relevant to the newly created instance.

Example output structure (simplified):

{
  "success": true,
  "instanceId": "string",
  "type": "ubuntu" | "browser" | "windows",
  "status": "starting" | "running",
  "otherDetails": { ... }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Scrapybara API via an API key credential.
  • The node uses the scrapybara npm package internally to interact with the API.
  • Proper configuration of the API key credential in n8n is necessary for authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication failures.
    • Specifying an unsupported instance type may result in errors or no instance being started.
    • Network connectivity issues to the Scrapybara API endpoint can cause timeouts or failures.

  • Error messages:

    • Errors thrown during instance start will include messages like Failed to start instance: <error message>.
    • If the API returns an error, it will be propagated and can be seen in the node's execution logs.

  • Resolution tips:

    • Verify that the API key credential is correctly set up and has sufficient permissions.
    • Ensure the instance type value matches one of the supported options.
    • Check network access and firewall settings to allow communication with the Scrapybara API.

Links and References

Discussion