APapify
Storage/Key-value stores

Get list of key-value stores

Changed on

Gets the list of key-value stores owned by the user.

The response is a list of objects, where each objects contains a basic information about a single key-value store.

The endpoint supports pagination using the limit and offset parameters and it will not return more than 1000 array elements.

By default, the records are sorted by the createdAt field in ascending order, therefore you can use pagination to incrementally fetch all key-value stores while new ones are still being created. To sort the records in descending order, use the desc=1 parameter.

get/v2/key-value-stores

Request

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

Query parameters

offsetnumber double

Number of items that should be skipped at the start. The default value is 0.

limitnumber double
Example:1000

Maximum number of items to return. The default value as well as the maximum is 1000.

descboolean
Example:true

If true or 1 then the objects are sorted by the createdAt field in descending order. By default, they are sorted in ascending order.

unnamedboolean
Example:true

If true or 1 then all the storages are returned. By default, only named storages are returned.

ownership'ownedByMe' | 'sharedWithMe'
Example:ownedByMe

Filter by ownership. If this parameter is omitted, all accessible key-value stores are returned.

  • ownedByMe: Return only key-value stores owned by the user.
  • sharedWithMe: Return only key-value stores shared with the user by other users.

Response

Example response

{
  "data": {
    "total": 1,
    "limit": 1000,
    "count": 1,
    "items": [
      {
        "id": "WkzbQMuFYuamGv3YF",
        "name": "d7b9MDYsbtX5L7XAj",
        "title": "My Store",
        "userId": "BPWDBd7Z9c746JAnF",
        "username": "janedoe",
        "createdAt": "2019-12-12T07:34:14.202Z",
        "modifiedAt": "2019-12-13T08:36:13.202Z",
        "accessedAt": "2019-12-14T08:36:13.202Z",
        "generalAccess": "RESTRICTED",
        "stats": {
          "readCount": 9,
          "writeCount": 3,
          "deleteCount": 6,
          "listCount": 2,
          "s3StorageBytes": 18
        }
      }
    ]
  }
}

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

  • e52dd2239ceeRevision changes
    • breaking

      the //// response's property type changed from object null to object string null for status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property //// to the response with the status