v1

latestOpenAPI 3.0.02026-08-06132933.0 KB

Data Sources

Create a data source

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.

post/v1/data-sources

Headers

Content-Typestring required

Must be set to application/json

Request body

accountIdinteger

Unique identifier for the Databox account.

titlestring required

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

timezonestring

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

Example request

{
  "accountId": 123456,
  "title": "ERP System",
  "timezone": "UTC"
}

Response

Successful response containing the newly created data source.

requestIdstring

Unique identifier for the request.

statusstring

Indicates the status of the request.

idinteger

Unique identifier for the data source.

titlestring

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

createdstring date-time

ISO 8601 timestamp when the data source was created.

timezonestring

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

keystring

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

ingestionSupportedboolean

Whether the data source supports dataset creation and data ingestion.

Example response

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