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

Auth

Authentication and API key validation operations.

Operations

Data Sources

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

Operations

Create a data source

Request

Creates an ingestion data source (a container for one or more datasets).

If accountId is provided, the data source is created in that account; otherwise, it is created in the account associated with the API key.

Requires a valid x-api-key with permission to create data sources in the target account.

Security
x-api-key
Headers
Content-Typestringrequired

Must be set to application/json

Bodyapplication/jsonrequired
accountIdinteger(int64)(accountId)

Unique identifier for the Databox account.

Example: 123456
titlestring(title.dataSource)required

Human-readable name of the data source. May be empty but not null.

Example: "ERP System"
timezonestring(timezone)

IANA time zone string indicating the data source time zone used for data visualization.

Example: "UTC"
curl -i -X POST \
  https://api.databox.com/v1/data-sources \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "accountId": 123456,
    "title": "ERP System",
    "timezone": "UTC"
  }'

Responses

Successful response containing the newly created data source.

Bodyapplication/json
requestIdstring

Unique identifier for the request.

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

Indicates the status of the request.

Example: "processing"
idinteger(int64)

Unique identifier for the data source.

Example: 4754489
titlestring

Human-readable name of the data source. May be empty but not null.

Example: "ERP System"
createdstring(date-time)

ISO 8601 timestamp when the data source was created.

Example: "2025-10-01T12:00:00.000000Z"
timezonestring

IANA time zone string indicating the data source time zone used for data visualization.

Example: "UTC"
keystring

Internal identifier for the data source. Defaults to "ingestion".

Example: "ingestion"
Response
application/json
{
  "requestId": "b0eac937-c25c-47a5-bb7e-552f6b860458",
  "status": "processing",
  "id": 4754489,
  "title": "ERP System",
  "created": "2025-10-01T12:00:00.000000Z",
  "timezone": "UTC",
  "key": "ingestion"
}

Delete a data source

Request

Permanently deletes the specified ingestion data source (dataSourceId).

Deleting a data source also deletes all datasets it contains (and their data). This action is irreversible.

Requires a valid x-api-key with permission to manage data sources in the target account.

Security
x-api-key
Path
dataSourceIdinteger(int64)(dataSourceId)required

Unique identifier for the data source.

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

Responses

Successful response indicating that the data source and all contained datasets were permanently deleted.

Bodyapplication/json
requestIdstring

Unique identifier for the request.

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

Indicates the status of the request.

Example: "success"
messagestring

Human-readable message describing the outcome of the request (for display/logging; not intended for programmatic parsing).

Example: "Resource deleted successfully"
Response
application/json
{
  "requestId": "b0eac937-c25c-47a5-bb7e-552f6b860458",
  "status": "success",
  "message": "Data source deleted successfully"
}

List datasets

Request

Retrieves all datasets that belong to the specified data source (dataSourceId).

Security
x-api-key
Path
dataSourceIdinteger(int64)(dataSourceId)required

Unique identifier for the data source.

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

Responses

Successful response containing a list of all datasets associated with the given data source.
If the data source has no datasets, the response will return an empty array.

Bodyapplication/json
requestIdstring

Unique identifier for the request.

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

Indicates the status of the request.

Example: "success"
datasetsArray of objects(Dataset)

List of datasets and their metadata.

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

Datasets

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

Operations