JustSERPDocs

Cancel a request

Names a request by the `cancel_token` sent with it.

GET
/v1/cancel

Names a request by the cancel_token sent with it. The job stops before its next attempt (never mid-page) and the request answers 499. Answers 202 whether the job had started, finished or never existed.

Authorization

headerX-API-Key<token>

Your API key.

Query Parameters

cancel_token*string

A name you make up for this request (a UUID is fine), so you can later GET /v1/cancel with it. Only you know it, so only you can cancel. Use a new one for every request, retries included: a cancelled token stays cancelled for a few minutes.

Length1 <= length <= 128

Response Body

Recorded.

application/json
  1. response
cancelled?boolean
Example Request
curl -X GET 'https://api.justserp.com/v1/cancel?cancel_token=7f3c2a9e-4b1d-4e8a-9c6f-2d5b8a1e0f43'
Example Response
{  "cancelled": true}