Sign in

v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Storage/Key-value stores

Update store

Updates a key-value store'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 key-value store object, as returned by the Get store API endpoint.

put/v2/key-value-stores/{storeId}

Path parameters

storeIdstring required
Example:WkzbQMuFYuamGv3YF

Key-value store ID or username~store-name.

Request body

namestring nullable
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-store-name",
  "generalAccess": "RESTRICTED"
}

Response

Example response

{
  "data": {
    "id": "WkzbQMuFYuamGv3YF",
    "name": "d7b9MDYsbtX5L7XAj",
    "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",
    "consoleUrl": "https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC",
    "keysPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123",
    "recordsPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records",
    "generalAccess": "RESTRICTED",
    "stats": {
      "readCount": 9,
      "writeCount": 3,
      "deleteCount": 6,
      "listCount": 2,
      "s3StorageBytes": 18,
      "storageBytes": 457225
    }
  }
}