Skip to main content

Prolong request lock

PUT 
/v2/request-queues/:queueId/requests/:requestId/lock

Prolongs request lock. The request lock can be prolonged only by the client that has locked it using Get and lock head operation.

The clientKey identifier is used for locking and unlocking requests. You can delete or prolong the lock only for requests that were locked by the same client key or from the same Actor run.

Request

Path Parameters

    queueId string required

    Queue ID or username~queue-name.


    Example: WkzbQMuFYuamGv3YF
    requestId string required

    Request ID.


    Example: xpsmkDlspokDSmklS

Query Parameters

    lockSecs double required

    How long the requests will be locked for (in seconds).


    Example: 60
    clientKey string

    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.


    Example: client-abc
    forefront string

    Determines if request should be added to the head of the queue or to the end after lock expires.


    Example: false

Status 200

Response Headers
    {
      "data": {
        "lockExpiresAt": "2022-06-14T23:00:00.000Z"
      }
    }