Download records

GET 
/v2/key-value-stores/:storeId/records

Downloads all records from the key-value store as a ZIP archive. Each record is stored as a separate file in the archive, with the filename equal to the record key.

You can optionally filter the records by collection or prefix to download only a subset of the store.

Request

Path Parameters

storeId string required
Key-value store ID or username~store-name.

Example: WkzbQMuFYuamGv3YF

Query Parameters

collection string
If specified, only records belonging 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.

Example: my-collection
prefix string
If specified, only records whose key starts with the given prefix are included in the archive.

Example: my-prefix/
signature string
Signature used for the access.

Example: 2wTI46Bg8qWQrV7tavlPI

Status 200

A ZIP archive containing the requested records.

Response Headers

"string"

Schema

• string string<binary>

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)

Status 401

Unauthorized - authentication required or invalid token.

{
  "error": {
    "type": "token-not-valid",
    "message": "Authentication token is not valid."
  }
}

Schema

• error object required

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

Status 403

Forbidden - insufficient permissions to perform this action.

{
  "error": {
    "type": "permission-denied",
    "message": "You do not have permission to perform this action."
  }
}

Schema

• error object required

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

Status 404

Not found - the requested resource was not found.

{
  "error": {
    "type": "record-not-found",
    "message": "Key-value Store was not found"
  }
}

Schema

• error object

  • type string

    Possible values: [record-not-found]

  • message string
    Example: Key-value Store was not found

Status 405

Method not allowed.

{
  "error": {
    "type": "method-not-allowed",
    "message": "This API end-point can only be accessed using the following HTTP methods: OPTIONS,GET"
  }
}

Schema

• error object required

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

Status 429

Too many requests - rate limit exceeded.

{
  "error": {
    "type": "rate-limit-exceeded",
    "message": "You have exceeded the rate limit. Please try again later."
  }
}

Schema

• error object required

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