Sign in
Default key-value store

Get default store's list of keys

Returns a list of keys for the default key-value store of the Actor run.

This endpoint is a shortcut for getting the run's defaultKeyValueStoreId and then using the Get list of keys endpoint.

get/v2/actor-runs/{runId}/key-value-store/keys

Path parameters

runIdstring required
Example:3KH8gEpp4d8uQSe8T

Actor run ID.

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"
  }
}

Changes

Changed in 2 of the 7 revisions of this API.14

  • 0a98d6a098a47See the full diff
    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 405

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 429

      response-property-enum-value-added

  • b94a8abdfff17See the full diff
    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 405

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 429

      response-property-enum-value-added