Skip to content
Squid

Update Squid

Update squid settings including parameters, concurrency, scheduling, and delivery integrations

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
POSThttps://api.lobstr.io/v1/squids/{squid_hash}

This endpoint updates an existing squid's settings using its hash ID. You can configure crawler parameters, execution settings, scheduling, notifications, and data delivery integrations.

Squid Settings

namestring

Display name for the squid. Example: "My Custom Squid"

is_activeboolean

Enable (true) or disable (false) the squid. Example: true

concurrencyinteger

Number of concurrent tasks to run simultaneously (1-20). Example: 2

to_completeboolean

Stop after all tasks complete (true) or run until credits exhausted (false). Example: false

export_unique_resultsboolean

Export only unique results, removing duplicates. Example: true

no_line_breaksboolean

Remove newlines from exported data. Example: true

run_notifystring

Notification preference: null (no notifications), "on_success", or "on_error". Example: "on_success"

cron_expressionstring

Cron expression for scheduling automated runs. Example: "0 10 * * *"

timezonestring

Timezone identifier for schedule execution. Example: "Europe/Paris"

paramsobject

The crawler's squid-level settings, from Get Crawler Parameters. Merged into the squid's current params: send only what changes, and functions merges too. An unknown name is refused with a 400 InvalidParam. Example: {"received_only": true, "fetch_since": "7d"}

accountsarray

Hashes of the connected accounts the squid uses, from List Accounts. Replaces the squid's accounts: send every account you want, [] removes them all. See Link Account to Squid. Example: ["0ecdae5e8cdd4a2c53c034a3047ea9b1"]

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Content-Typestringheaderrequired

Must be application/json. Value: application/json

Path Parameters

squid_hashstringpathrequired

The unique identifier (hash) of the squid to update. Example: e86b29c032024b66aff529e1d43c2bd7

The params object structure depends on the crawler. Use Get Crawler Parameters endpoint to see available options before updating.

Optional function parameters (in params.functions) cost extra credits per row. Check the crawler details for pricing.

Setting is_active to false will prevent the squid from running. Use this to temporarily pause a squid without deleting it.

You can update just one field at a time - send only the fields you want to change. Other settings remain unchanged.

Use cron_expression and timezone to schedule recurring runs. Common patterns: '0 9 ' (daily at 9am), '0 0 * 0' (weekly on Sunday).

Code Examples

curl -X POST "https://api.lobstr.io/v1/squids/e86b29c032024b66aff529e1d43c2bd7" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Squid Name",
    "concurrency": 2,
    "is_active": true,
    "params": {
      "max_results": 150,
      "functions": {
        "extract_emails_from_website": true,
        "collect_business_details": true,
        "fetch_business_images": false
      },
      "ratings": "4.0+",
      "country": "United States",
      "language": "English (United States)"
    },
    "run_notify": "on_success"
  }'

Response

201
{
  "name": "Updated Squid Name",
  "no_line_breaks": true,
  "is_active": true,
  "params": {
    "max_results": 150,
    "functions": {
      "extract_emails_from_website": true,
      "collect_business_details": true,
      "fetch_business_images": false
    },
    "ratings": "4.0+",
    "country": "United States",
    "language": "English (United States)"
  },
  "to_complete": false,
  "run_notify": "on_success",
  "export_unique_results": true
}