v3

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

Unlock requests

Unlocks requests in the queue that are currently locked by the client.

  • If the client is within an Actor run, it unlocks all requests locked by that specific run plus all requests locked by the same clientKey.
  • If the client is outside of an Actor run, it unlocks all requests locked using the same clientKey.
post/v2/request-queues/{queueId}/requests/unlock

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.

Response

Number of requests that were unlocked

Example response

{
  "data": {
    "unlockedCount": 10
  }
}