Skip to content

Enable or disable a URL

PATCH
/api/v1/urls/{id}/toggle
Code sample: cURL
curl -X PATCH 'https://api.justcrawl.io/api/v1/urls/00000000-0000-0000-0000-000000000001/toggle' \
-H 'Authorization: Bearer $JUSTCRAWL_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"isEnabled": false}'

Flips whether a URL participates in future schedule runs. A disabled URL keeps its ID, history, and extraction results, and stays visible in GET /api/v1/urls — it is simply skipped when schedules dispatch. This is the reversible alternative to DELETE /api/v1/urls/{id}.

id
required
string format: uuid

URL item ID.

Media typeapplication/json
object
isEnabled
required

True to resume scraping this URL, false to pause it.

boolean
Examplegenerated
{
"isEnabled": true
}

The URL’s new enabled state.

Media typeapplication/json
object
id
string format: uuid
isEnabled
boolean
Examplegenerated
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"isEnabled": true
}

isEnabled missing or not a boolean.

Missing or invalid authentication token

Media typeapplication/json
object
error
string
Example
{
"error": "Missing or invalid authentication token"
}

Insufficient permissions for this operation

Media typeapplication/json
object
error
string
Example
{
"error": "No organization. Complete onboarding first."
}

URL not found.

Unexpected server error. Logs and PostHog $exception capture

Media typeapplication/json
object
error
string
Example
{
"error": "Something went wrong"
}