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
• generalAccess GeneralAccessEnum (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
    }
  }
}

Schema

• data object required

  • id string required
    Example: WkzbQMuFYuamGv3YF
  • name string
    Example: d7b9MDYsbtX5L7XAj
  • userId string | null nullable
    Example: BPWDBd7Z9c746JAnF
  • username string | null nullable
    Example: janedoe
  • createdAt string<date-time> required
    Example: 2019-12-12T07:34:14.202Z
  • modifiedAt string<date-time> required
    Example: 2019-12-13T08:36:13.202Z
  • accessedAt string<date-time> required
    Example: 2019-12-14T08:36:13.202Z
  • actId string | null nullable
    Example: null
  • actRunId string | null nullable
    Example: null
  • consoleUrl string<uri>
    Example: https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC
  • keysPublicUrl string<uri>

    A public link to access keys of the key-value store directly.

    
    Example: https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123
  • urlSigningSecretKey string | null nullable

    A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store.

  • generalAccess GeneralAccessEnum (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
  • stats object

    • readCount integer required
      Example: 9
    • writeCount integer required
      Example: 3
    • deleteCount integer required
      Example: 6
    • listCount integer required
      Example: 2
    • s3StorageBytes integer
      Example: 18

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)