Skip to main content
POST
/
v1
/
squids
/
{squid_hash}
Update Squid
curl --request POST \
  --url https://api.lobstr.io/v1/squids/{squid_hash} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "name": "<string>",
  "is_active": true,
  "concurrency": 123,
  "to_complete": true,
  "export_unique_results": true,
  "no_line_breaks": true,
  "run_notify": "<string>",
  "cron_expression": "<string>",
  "timezone": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

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

​
name
string
Display name for the squid. Example: "My Custom Squid"
​
is_active
boolean
Enable (true) or disable (false) the squid. Example: true
​
concurrency
integer
Number of concurrent tasks to run simultaneously (1-20). Example: 2
​
to_complete
boolean
Stop after all tasks complete (true) or run until credits exhausted (false). Example: false
​
export_unique_results
boolean
Export only unique results, removing duplicates. Example: true
​
no_line_breaks
boolean
Remove newlines from exported data. Example: true
​
run_notify
string
Notification preference: null (no notifications), “on_success”, or “on_error”. Example: "on_success"
​
cron_expression
string
Cron expression for scheduling automated runs. Example: "0 10 * * *"
​
timezone
string
Timezone identifier for schedule execution. Example: "Europe/Paris"

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
​
Content-Type
string
required
Must be application/json. Value: application/json

​
Query Parameters

​
squid_hash
string
required
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

200
{
  "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
}