Skip to main content

Update store

PUT 
/v2/key-value-stores/:storeId

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.

Request

Path Parameters

    storeId string required

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


    Example: WkzbQMuFYuamGv3YF

Bodyrequired

  • name string | null nullable
  • generalAccess GeneralAccess (string)

    Defines the general access level for the resource.

    Possible values: [ANYONE_WITH_ID_CAN_READ, ANYONE_WITH_NAME_CAN_READ, FOLLOW_USER_SETTING, RESTRICTED]


    Example: RESTRICTED

Status 200

Response Headers
    {
      "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",
        "actId": null,
        "actRunId": null,
        "consoleUrl": "https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC",
        "keysPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123",
        "urlSigningSecretKey": "string",
        "generalAccess": "RESTRICTED",
        "stats": {
          "readCount": 9,
          "writeCount": 3,
          "deleteCount": 6,
          "listCount": 2,
          "s3StorageBytes": 18
        }
      }
    }