POST/v1/squids/{squid_hash}/empty

Empty Squid

Remove all tasks and results from a squid while keeping its configuration intact

This endpoint removes all tasks and their associated results from a specified squid, returning the number of deleted items while keeping the squid's configuration intact.

What Gets Deleted

Depending on the type parameter:

  • url: Removes all URL-based tasks and their results
  • params: Removes all parameter-based tasks and their results

The squid itself remains with all its settings (name, parameters, integrations, schedule) preserved. This is useful when you want to:

  • Clear old tasks before adding new ones
  • Reset a squid without losing its configuration
  • Remove tasks that are no longer needed

Headers

KeyValueRequired
AuthorizationToken YOUR_API_KEYYes
Content-Typeapplication/jsonYes

Request Body

typestring
Required
Type of tasks to remove: 'url' for URL-based tasks or 'params' for parameter-based tasks
Example: url

Response Field Explanations

id
string
Squid identifier
Example: 388d6d5e98134294ac612ec9f99dc5b1
object
string
Always "squid"
Example: squid
emptied
boolean
Boolean indicating success
Example: true
deleted_count
integer
Number of tasks deleted
Example: 150

Parameters

squid_hashstring
Required
The unique identifier (hash) of the squid to empty
Example: 388d6d5e98134294ac612ec9f99dc5b1
Warning

Warning

This action is irreversible. All tasks and results of the specified type will be permanently deleted.
Pro Tip

Pro Tip

Use this before re-importing tasks to avoid duplicates. Empty the squid, then add fresh tasks.
Note

Note

The squid's configuration (parameters, integrations, schedule) is preserved. Only tasks and results are removed.
Pro Tip

Pro Tip

Check the 'deleted_count' in the response to verify how many tasks were removed.
Warning

Warning

If a run is currently active, stop it before emptying the squid to avoid conflicts.