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

Validate an API key

Request

Validates the API key supplied in the x-api-key header.

Use this endpoint as a setup/health check. Integration partners can call it to confirm a customer's key before enabling data ingestion or completing account linking.

  • 200 OK: Key is valid.
  • 401 Unauthorized: Key is missing or invalid (standard error envelope).
Security
x-api-key
curl -i -X GET \
  https://api.databox.com/v1/auth/validate-key \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response confirming the provided API key is valid.

Bodyapplication/json
requestIdstring

Unique identifier for the request.

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

Indicates the status of the request.

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

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