TOtovuk
Scrapers

Cancel scraper request

Changed on

Cancels a queued or running scraper Request.

post/v1/requests/{request_id}/cancel

Request

  • Base URL
    https://api.tovuk.com
  • Auth
    HTTP bearer

Path parameters

request_idstring required
Example:request_123

Scraper Request id. Context $.paths./v1/requests/{request_id}/cancel.post.parameters.0.

Response

Scraper request canceled.

requestIdstring required
canceledboolean required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
agentInstructionstring required

Example response

{
  "requestId": "request_123",
  "canceled": true,
  "status": "canceled",
  "agentInstruction": "Request canceled. Create a new scraper request when ready."
}

Changes

  • c7b37eaf7c38Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3985c6090c91Revision changes
    • info

      endpoint added