Scrapybara icon

Scrapybara

Interact with the Scrapybara API
Join our community

Actions8

Overview

This node integrates with the Scrapybara API to manage and interact with virtual instances. Specifically, the "Pause" operation allows users to pause a running instance by its ID. Pausing an instance temporarily halts its activity without fully stopping or terminating it, which can be useful for saving resources or pausing work in progress.

Common scenarios include:

  • Temporarily suspending an instance during off-hours to save costs.
  • Pausing an instance before performing maintenance or updates.
  • Managing instance lifecycle dynamically within automated workflows.

Example: A user might pause a browser instance running automated tests when no tests are scheduled, then resume it later.

Properties

Name Meaning
Instance ID The unique identifier of the instance to pause. This is required to specify which instance should be paused.

Output

The output JSON object includes:

  • success: A boolean indicating whether the pause operation was successful.
  • instanceId: The ID of the instance that was paused.

Example output:

{
  "success": true,
  "instanceId": "abc123"
}

No binary data is produced by this operation.

Dependencies

  • Requires an active connection to the Scrapybara API using an API key credential.
  • The node depends on the external scrapybara client library to communicate with the API.
  • Proper API credentials must be configured in n8n for authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Instance ID: The operation requires a valid instance ID; ensure it is correctly provided.
    • Network or API errors: Connectivity issues or invalid API keys will cause failures.
    • Instance state conflicts: Trying to pause an instance that is already paused or stopped may result in errors.

  • Error messages:

    • Failed to pause instance <ID>: <error message>: Indicates the pause request failed. Check if the instance ID is correct and the instance is in a state that can be paused.

  • Resolution tips:

    • Verify the instance ID exists and is active.
    • Confirm API credentials are valid and have necessary permissions.
    • Check network connectivity to the Scrapybara API endpoint.

Links and References

Discussion