Version: Next

KeyValueStore

Represents a Key-Value Store storage on the Apify platform.

Key-value stores are used to store arbitrary data records or files. Each record is identified by a unique key and can contain any data - JSON objects, strings, binary files, etc.

Hierarchy

Omit<Schemas[KeyValueStore], keyof KeyValueStoreRePointed>
KeyValueStoreRePointed
KeyValueStoreSpecGaps
- KeyValueStore

Index

Properties

accessedAt
actId
actRunId
consoleUrl
createdAt
generalAccess
id
keysPublicUrl
modifiedAt
name
recordsPublicUrl
schema
stats
title
urlSigningSecretKey
userId
username

Properties

inheritedaccessedAt

accessedAt: Date

Format: date-time

2019-12-14T08:36:13.202Z

optionalinheritedactId

actId?: null | string

null

optionalinheritedactRunId

actRunId?: null | string

null

optionalinheritedconsoleUrl

consoleUrl?: string

Format: uri

https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC

inheritedcreatedAt

createdAt: Date

Format: date-time

2019-12-12T07:34:14.202Z

optionalinheritedgeneralAccess

generalAccess?: null | STORAGE_GENERAL_ACCESS

inheritedid

id: string

WkzbQMuFYuamGv3YF

optionalinheritedkeysPublicUrl

keysPublicUrl?: string

Format: uri

https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123

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

inheritedmodifiedAt

modifiedAt: Date

Format: date-time

2019-12-13T08:36:13.202Z

optionalinheritedname

name?: null | string

d7b9MDYsbtX5L7XAj

optionalinheritedrecordsPublicUrl

recordsPublicUrl?: string

Format: uri

https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records

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

optionalinheritedschema

schema?: null | Record<string, unknown>

Optional JSON schema describing the keys stored in the key-value store.

optionalinheritedstats

stats?: KeyValueStoreStats

optionalinheritedtitle

title?: string

optionalinheritedurlSigningSecretKey

urlSigningSecretKey?: null | string

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

optionalinheriteduserId

userId?: null | string

BPWDBd7Z9c746JAnF

optionalinheritedusername

username?: null | string

janedoe