Skip to content
Last updated

Changelog

Version:

v1.0

Initial release

This is the first release of the Databox Ingestion API. It establishes the foundation for managing data sources, datasets and data ingestions. The API is still under development, and more functionality will be added in future versions.

Available endpoints

Accounts

  • GET /v1/accounts — Retrieves all accounts accessible to the user associated with the API key.

  • GET /v1/accounts/{accountId}/data-sources — Retrieves the list of ingestible data sources available for the specified account.

  • GET /v1/accounts/timezones — Retrieves the list of all timezones supported by Databox, including their UTC offsets and IANA identifiers.

Auth

  • GET /v1/auth/validate-key — Validates the API key supplied in the x-api-key header.

Data Sources

  • POST /v1/data-sources — Creates an ingestion data source (a container for one or more datasets).

  • DELETE /v1/data-sources/{dataSourceId} — Permanently deletes the specified ingestion data source (dataSourceId).

  • GET /v1/data-sources/{dataSourceId}/datasets — Retrieves all datasets that belong to the specified data source (dataSourceId).

Datasets

  • POST /v1/datasets — Creates a new dataset within the specified data source.

  • DELETE /v1/datasets/{datasetId} — Deletes the specified dataset.

  • POST /v1/datasets/{datasetId}/purge — Purges the specified dataset by removing all rows of data it contains.

  • POST /v1/datasets/{datasetId}/data — Adds a batch of data records to the specified dataset through an ingestion event.

  • GET /v1/datasets/{datasetId}/ingestions — Retrieves a list of ingestions events that have been created for the specified dataset.

  • GET /v1/datasets/{datasetId}/ingestions/{ingestionId} — Retrieves detailed information for an ingestion event, allowing you to check processing progress and outcomes.

Previous page
Next page