Connecting to Databox
Using API Key Authentication
To use the Databox API, you need to generate a personal access key from your Databox account. Navigate to the Databox account settings under Data Manager and generate an API key (prefixed with pak_).
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Databox personal access key.
Example connection string:
Profile=C:\profiles\Databox.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"
Available Tables
The Databox profile provides access to the following tables:
- Accounts - Databox accounts accessible to the API key
- DataSources - Ingestion data sources for an account (requires AccountId)
- Timezones - Timezones supported by Databox with UTC offsets
- Datasets - Datasets belonging to a data source (requires DataSourceId)
- Ingestions - Ingestion events for a dataset (requires DatasetId)
- IngestionDetails - Metrics for a single ingestion event (requires DatasetId and IngestionId)
Usage Examples
Accounts:
SELECT * FROM Accounts
DataSources:
SELECT * FROM DataSources WHERE AccountId = '756131'
Timezones:
SELECT * FROM Timezones
Datasets:
SELECT * FROM Datasets WHERE DataSourceId = '4976164'
Ingestions:
SELECT * FROM Ingestions WHERE DatasetId = 'd4dcdde6-f0a1-4387-8562-152183a02d29'
IngestionDetails:
SELECT * FROM IngestionDetails WHERE DatasetId = 'd4dcdde6-f0a1-4387-8562-152183a02d29' AND IngestionId = '8bfba187-84f4-41e2-9dd3-bee4bb884205'
Connection Properties
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.
| Property | Description |
| APIKey | The API key for your Databox account. |
| AuthScheme | The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD |