SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Stop a running crawl

POSThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/crawls/{crawl_id}/cancel

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

site_idstringrequired
crawl_idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Response

Response Body

idstringCrawl id. Use it as crawl_id.
statusstringqueued, running, completed, failed or cancelled.
pages_budgetintegerPages the crawl may read.
pages_crawledintegerPages read so far.
links_foundintegerLinks recorded so far.
broken_countintegerBroken internal links found.
truncatedbooleanThe crawl stopped before it had read every page it found.
error_messagestring | nullA plain explanation of why the crawl failed, when it did.
started_atstring | nullWhen crawling began.
finished_atstring | nullWhen it ended.
created_atstringWhen it was requested.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/crawls/{crawl_id}/cancel \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"status": "completed",
"pages_budget": 500,
"pages_crawled": 212,
"links_found": 1830,
"broken_count": 4,
"truncated": false,
"error_message": null,
"started_at": null,
"finished_at": null,
"created_at": "2026-09-01T09:00:00.000Z"
}
}