v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Storage/Request queues

Delete requests

Batch-deletes given requests from the queue. The number of requests in a batch is limited to 25. The response contains an array of unprocessed and processed requests. If any delete operation fails because the request queue rate limit is exceeded or an internal failure occurs, the failed request is returned in the unprocessedRequests response parameter. You can re-send these delete requests. It is recommended to use an exponential backoff algorithm for these retries. Each request is identified by its ID or uniqueKey parameter. You can use either of them to identify the request.

delete/v2/request-queues/{queueId}/requests/batch

Path parameters

queueIdstring required
Example:WkzbQMuFYuamGv3YF

Queue ID or username~queue-name.

Query parameters

clientKeystring
Example:client-abc

A unique identifier of the client accessing the request queue. It must be a string between 1 and 32 characters long. This identifier is used to determine whether the queue was accessed by multiple clients. If clientKey is not provided, the system considers this API call to come from a new client. For details, see the hadMultipleClients field returned by the Get head operation.

Headers

Content-Type'application/json' required

Request body

Example request

[
  {
    "id": "sbJ7klsdf7ujN9l",
    "uniqueKey": "GET|60d83e70|e3b0c442|https://apify.com"
  }
]

Response

Example response

{
  "data": {
    "processedRequests": [
      {
        "uniqueKey": "GET|60d83e70|e3b0c442|https://apify.com",
        "id": "sbJ7klsdf7ujN9l"
      }
    ],
    "unprocessedRequests": [
      {
        "id": "sbJ7klsdf7ujN9l",
        "uniqueKey": "GET|60d83e70|e3b0c442|https://apify.com",
        "url": "https://apify.com",
        "method": "GET"
      }
    ]
  }
}