Create key-value store

POST 
/v2/key-value-stores

Creates a key-value store and returns its object. The response is the same object as returned by the Get store endpoint.

Keep in mind that data stored under unnamed store follows data retention period.

It creates a store with the given name if the parameter name is used. If there is another store with the same name, the endpoint does not create a new one and returns the existing object instead.

Request

Query Parameters

name string
Custom unique name to easily identify the store in the future.

Example: eshop-values

Status 201

Response Headers

• Location

{
  "data": {
    "id": "WkzbQMuFYuamGv3YF",
    "name": "d7b9MDYsbtX5L7XAj",
    "userId": "wRsJZtadYvn4mBZmm",
    "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/WkzbQMuFYuamGv3YF",
    "keysPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123"
  }
}

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)