APapify
Storage/Request queues/Requests locks

Get and lock request queue head

Changed on

Returns the given number of first requests from the queue and locks them for the given time.

If this endpoint locks the request, no other client or run will be able to get and lock these requests.

The response contains the hadMultipleClients boolean field which indicates that the queue was accessed by more than one client (with unique or empty clientKey).

post/v2/request-queues/{queueId}/head/lock

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Path parameters

queueIdstring required
Example:WkzbQMuFYuamGv3YF

Queue ID or username~queue-name.

Query parameters

lockSecsnumber double required
Example:60

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

limitnumber double
Example:25

How many items from the queue should be returned.

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 request queue head endpoint.

Response

Example response

{
  "data": {
    "limit": 3,
    "queueModifiedAt": "2018-03-14T23:00:00.000Z",
    "hadMultipleClients": true,
    "lockSecs": 60,
    "items": [
      {
        "id": "8OamqXBCpPHxyj9",
        "retryCount": 0,
        "uniqueKey": "http://example.com",
        "url": "http://example.com",
        "method": "GET",
        "lockExpiresAt": "2022-06-14T23:00:00.000Z"
      },
      {
        "id": "8OamqXBCpPHxyx9",
        "retryCount": 0,
        "uniqueKey": "http://example.com/a",
        "url": "http://example.com/a",
        "method": "GET",
        "lockExpiresAt": "2022-06-14T23:00:00.000Z"
      },
      {
        "id": "8OamqXBCpPHxy08",
        "retryCount": 0,
        "uniqueKey": "http://example.com/a/b",
        "url": "http://example.com/a/b",
        "method": "GET",
        "lockExpiresAt": "2022-06-14T23:00:00.000Z"
      }
    ]
  }
}

Changes

  • ec76185eb934Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 16b486b0397aRevision changes
    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status