Storage/Key-value stores
Get list of keys
Returns a list of objects describing keys of a given key-value store, as well as some information about the values (e.g. size).
This endpoint is paginated using exclusiveStartKey and limit parameters
- see Pagination for more details.
get/v2/key-value-stores/{storeId}/keys
Path parameters
storeIdstring required
Example:WkzbQMuFYuamGv3YF
Key-value store ID or username~store-name.
Query parameters
exclusiveStartKeystring
Example:Ihnsp8YrvJ8102Kj
All keys up to this one (including) are skipped from the result.
limitnumber
Example:100
Number of keys to be returned.
collectionstring
Example:postImages
Limit the results to keys that belong to a specific collection from the key-value store schema. The key-value store need to have a schema defined for this parameter to work.
prefixstring
Example:post-images-
Limit the results to keys that start with a specific prefix.
signaturestring
Example:2wTI46Bg8qWQrV7tavlPI
Signature used for the access.
Response
Example response
{
"data": {
"items": [
{
"key": "second-key",
"size": 36,
"recordPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/second-key?signature=abc123"
},
{
"key": "third-key",
"size": 128,
"recordPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/third-key?signature=abc123"
}
],
"count": 2,
"limit": 2,
"exclusiveStartKey": "some-key",
"isTruncated": true,
"nextExclusiveStartKey": "third-key"
}
}