Claim icon

Claim

Allow to claim an instance with claim-controller

Actions3

Create Instance

AI-generated

Summary

Claims a remote Playwright instance by POSTing to a claim controller's /claim endpoint with a TTL, and returns the WebSocket browser endpoint and claim metadata for use by downstream nodes.

Inputs

  • Claim Controller URL (required) — Base URL of the claim controller (e.g. http://claim-controller:8080). Trailing slashes are trimmed and the node posts to /claim.
  • TTL (required) — Time to live for the claim, as a duration string such as 3m or 10m (default 3m). Sent as {"ttl": ...} in the JSON body. Must not be empty.
  • Claim Timeout — Maximum time to wait for the controller response, in milliseconds (default 120000). The request is aborted after this.

Output shape

One item per input item, with json fields: browserEndpoint (ws://), claimId, claimControllerUrl, expiresAt, preProvisioned, releaseMethod, releasePath, renewMethod, renewPath and status. Each item is paired to its input item.

The controller response must be valid JSON containing id and data.fqdn. Otherwise the node errors, as it does on network failure, timeout or a non-2xx status. With Continue On Fail enabled, the item becomes {error: message}. The node sends an X-Session-ID header built from the workflow ID, workflow name and execution ID. In manual or test mode the suffix is 'dev'. The optional metadata fields are undefined if the controller omits them. The claimId is what the Renew Claim and Release Claim operations need.

Examples

Example 1: Claim a browser at the start of a scraping workflow and keep it alive for 10 minutes.

Claim Controller URL = http://claim-controller:8080, TTL = 10m, Claim Timeout = 120000. Pass browserEndpoint and claimId to later nodes.

Example 2: Fail fast when the controller has no capacity.

Claim Timeout = 15000, TTL = 3m, with Continue On Fail enabled so the workflow can branch on the error field.

Links

Discussion