v3

OpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB

Storage/Request queues

Update request queue

Updates a request queue's name and general resource access level using a value specified by a JSON object passed in the PUT payload.

The response is the updated request queue object, as returned by the Get request queue API endpoint.

put/v2/request-queues/{queueId}

Path parameters

queueIdstring required

Example:WkzbQMuFYuamGv3YF

Queue ID or username~queue-name.

Request body

namestring nullable

The new name for the request queue.

generalAccess'ANYONE_WITH_ID_CAN_READ' | 'ANYONE_WITH_NAME_CAN_READ' | 'FOLLOW_USER_SETTING' | 'RESTRICTED'

Defines the general access level for the resource.

Example request

{
  "name": "new-request-queue-name"
}

Response

Example response

{
  "data": {
    "id": "WkzbQMuFYuamGv3YF",
    "name": "some-name",
    "userId": "wRsJZtadYvn4mBZmm",
    "createdAt": "2019-12-12T07:34:14.202Z",
    "modifiedAt": "2019-12-13T08:36:13.202Z",
    "accessedAt": "2019-12-14T08:36:13.202Z",
    "totalRequestCount": 870,
    "handledRequestCount": 100,
    "pendingRequestCount": 670,
    "hadMultipleClients": true,
    "consoleUrl": "https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC",
    "stats": {
      "headItemReadCount": 5,
      "readCount": 100,
      "storageBytes": 1024,
      "writeCount": 10
    },
    "generalAccess": "RESTRICTED"
  }
}