Skip to content

Databox API (v1)

The Databox API allows you to integrate Databox with external systems, automate data ingestion, and extend platform functionality. It follows REST conventions with resource-oriented URLs, JSON request/response bodies, and standard HTTP methods/status codes.

Download OpenAPI description
api.databox.com.json
api.databox.com.yaml
Languages
Servers
Production server
https://api.databox.com/

Accounts

Access account details, configuration, and associated resources.

Operations

List accounts

Request

Retrieves all accounts accessible to the user associated with the API key.

Security
x-api-key
curl -i -X GET \
  https://api.databox.com/v1/accounts \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response containing the accounts accessible to the authenticated user.

Bodyapplication/json
requestIdstring

Unique identifier for the request.

Example: "b0eac937-c25c-47a5-bb7e-552f6b860458"
statusstring

Indicates the status of the request.

Example: "success"
accountsArray of objects(Account)

List of accounts.

Response
application/json
{
  "requestId": "b0eac937-c25c-47a5-bb7e-552f6b860458",
  "status": "success",
  "accounts": [
    { … }
  ]
}

List data sources

Request

Retrieves the list of ingestible data sources available for the specified account.
Only data sources that can accept ingested data and be created via the API are included.

Security
x-api-key
Path
accountIdinteger(int64)(accountId)required

Unique identifier for the Databox account.

Example: 123456
curl -i -X GET \
  https://api.databox.com/v1/accounts/123456/data-sources \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response containing the list of ingestible data sources available for the account.

Bodyapplication/json
requestIdstring

Unique identifier for the request.

Example: "b0eac937-c25c-47a5-bb7e-552f6b860458"
statusstring

Indicates the status of the request.

Example: "success"
dataSourcesArray of objects(DataSource)

List of ingestible data sources.

Response
application/json
{
  "requestId": "b0eac937-c25c-47a5-bb7e-552f6b860458",
  "status": "success",
  "dataSources": [
    { … }
  ]
}

List time zones

Request

Retrieves the list of all timezones supported by Databox, including their UTC offsets and IANA identifiers.

Security
x-api-key
curl -i -X GET \
  https://api.databox.com/v1/accounts/timezones \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response containing the list of supported time zones.

Bodyapplication/json
requestIdstring

Unique identifier for the request.

Example: "b0eac937-c25c-47a5-bb7e-552f6b860458"
statusstring

Indicates the status of the request.

Example: "success"
timezonesArray of objects(Timezone)

List of supported time zones with their UTC offsets and IANA identifiers.

Response
application/json
{
  "requestId": "b0eac937-c25c-47a5-bb7e-552f6b860458",
  "status": "success",
  "timezones": [
    { … }
  ]
}

Auth

Authentication and API key validation operations.

Operations

Data Sources

Create and delete data sources; list datasets for a data source.

Operations

Datasets

Create, ingest into, purge, and delete datasets; list and inspect ingestions.

Operations