# Databox API

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.


Version: v2

## Servers

Production server
```
https://api.databox.com
```

## Security

### x-api-key

API key for authentication

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

 - [Databox API](https://developers.databox.com/_bundle/docs/@v2/api/api.databox.com.yaml)

## Accounts

 - [GET /v2/accounts](https://developers.databox.com/docs/api/api.databox.com/accounts/accounts_getaccounts.md): Retrieves a paginated list of accounts in the organization associated with the authenticated user.
 - [POST /v2/accounts](https://developers.databox.com/docs/api/api.databox.com/accounts/accounts_createaccount.md): Creates an account in the organization associated with the authenticated user. Only [managed accounts](http://help.databox.com/databox-glossary#m) can be created through this operation.
 - [GET /v2/accounts/{id}](https://developers.databox.com/docs/api/api.databox.com/accounts/accounts_getaccountbyid.md): Retrieves details about a specific account.
 - [PATCH /v2/accounts/{id}](https://developers.databox.com/docs/api/api.databox.com/accounts/accounts_updateaccount.md): Updates information for a specific account.
 - [DELETE /v2/accounts/{id}](https://developers.databox.com/docs/api/api.databox.com/accounts/accounts_deleteaccount.md): Deletes a specific account from the organization associated with the authenticated user.
## Auth

 - [GET /v2/auth/validate-key](https://developers.databox.com/docs/api/api.databox.com/auth/auth_validateapikey.md): 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 comp
## Billing

 - [GET /v2/billing](https://developers.databox.com/docs/api/api.databox.com/billing/billing_getbilling.md): Retrieves billing and subscription details for the organization associated with the authenticated user. Organizations can retrieve an account's billing details by passing `x-account-id`, but only for
 - [GET /v2/billing/invoices](https://developers.databox.com/docs/api/api.databox.com/billing/billing_getinvoices.md): Retrieves a paginated list of invoices for the organization associated with the authenticated user. Organizations can retrieve an account's invoices by passing `x-account-id`, but only for **self-mana
## Connections

 - [GET /v2/connections](https://developers.databox.com/docs/api/api.databox.com/connections/connections_getconnections.md): Retrieves a paginated list of connections in the organization.
 - [GET /v2/connections/{id}](https://developers.databox.com/docs/api/api.databox.com/connections/connections_getconnectionbyid.md): Retrieves details about a specific connection.
 - [PATCH /v2/connections/{id}](https://developers.databox.com/docs/api/api.databox.com/connections/connections_updateconnection.md): Updates information for a specific connection.
 - [DELETE /v2/connections/{id}](https://developers.databox.com/docs/api/api.databox.com/connections/connections_deleteconnection.md): Deletes a specific connection from the organization.
 - [GET /v2/connections/{id}/permissions](https://developers.databox.com/docs/api/api.databox.com/connections/connections_getconnectionpermissions.md): Retrieves the permissions configured for a specific connection.
 - [PUT /v2/connections/{id}/permissions](https://developers.databox.com/docs/api/api.databox.com/connections/connections_updateconnectionpermissions.md): Updates the permissions for a specific connection.
## Data Sources

 - [GET /v2/data-sources](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_getdatasources.md): Retrieves a paginated list of data sources in the organization.
 - [POST /v2/data-sources](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_createdatasource.md): Creates a data source for sending custom data to Databox through the API.
 - [GET /v2/data-sources/{id}](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_getdatasourcebyid.md): Retrieves details about a specific data source.
 - [PATCH /v2/data-sources/{id}](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_updatedatasource.md): Updates information for a specific data source.
 - [DELETE /v2/data-sources/{id}](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_deletedatasource.md): Permanently deletes a specific data source from the organization. Deleting a data source also deletes all datasets it contains (and their data). **This operation is irreversible — once deleted, the da
 - [GET /v2/data-sources/{id}/permissions](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_getpermissions.md): Retrieves the permissions configured for a specific data source.
 - [PUT /v2/data-sources/{id}/permissions](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_updatepermissions.md): Updates the permissions for a specific data source.
 - [POST /v2/data-sources/{id}/purge](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_purgedatasource.md): Permanently deletes all data stored in a specific data source. Data in the original source is not affected. **This operation is irreversible — once purged, the deleted data cannot be restored.**
 - [PUT /v2/data-sources/{id}/sync-frequency](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_updatesyncfrequency.md): Updates the sync frequency for a specific data source.
 - [GET /v2/data-sources/{id}/sync-frequency-options](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_getavailablesyncfrequencies.md): Retrieves the sync frequencies available for a specific data source.
 - [PUT /v2/data-sources/{id}/timezone](https://developers.databox.com/docs/api/api.databox.com/data-sources/datasources_updatedatasourcetimezone.md): Updates the time zone for a specific data source.
## Databoards

 - [GET /v2/databoards](https://developers.databox.com/docs/api/api.databox.com/databoards/databoards_listdataboards.md): Retrieves a paginated list of Databoards in the organization.
 - [GET /v2/databoards/{id}/metrics](https://developers.databox.com/docs/api/api.databox.com/databoards/databoards_getdataboardmetrics.md): Retrieves the Datablocks and associated metric configurations for a specific Databoard.
## Datasets

 - [GET /v2/datasets](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_listdatasets.md): Retrieves a paginated list of datasets available to the authenticated user.
 - [POST /v2/datasets](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_createdataset.md): Creates a dataset in the specified data source.
 - [GET /v2/datasets/modifications/functions](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getmodificationfunctions.md): Retrieves the functions available for calculated columns in dataset modifications.
 - [GET /v2/datasets/modifications/rules](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getmodificationrules.md): Retrieves the rules available for configuring dataset modifications.
 - [GET /v2/datasets/{id}](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getdataset.md): Retrieves details about the specified dataset.
 - [PATCH /v2/datasets/{id}](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_updatedataset.md): Updates the properties of the specified dataset and returns the updated dataset.
 - [DELETE /v2/datasets/{id}](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_deletedataset.md): Permanently deletes the specified dataset and its stored data.
 - [GET /v2/datasets/{id}/column-metadata](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getcolumnmetadata.md): Retrieves metadata configured for the columns in the specified dataset.
 - [PATCH /v2/datasets/{id}/column-metadata](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_updatecolumnmetadata.md): Updates metadata for one or more columns in the specified dataset.
 - [GET /v2/datasets/{id}/data](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getdatasetdata.md): Retrieves a paginated list of records stored in the specified dataset.
 - [POST /v2/datasets/{id}/data](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_ingestdata.md): Submits records for ingestion into the specified dataset.
 - [POST /v2/datasets/{id}/duplicate](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_duplicatedataset.md): Creates a copy of the specified dataset.
 - [GET /v2/datasets/{id}/ingestion-statistics](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getingestionstatistics.md): Retrieves ingestion performance statistics for the specified dataset.
 - [GET /v2/datasets/{id}/ingestions](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getingestions.md): Retrieves a paginated list of ingestion attempts for the specified dataset.
 - [GET /v2/datasets/{id}/ingestions/{ingestionId}](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getingestion.md): Retrieves details about the specified dataset ingestion.
 - [GET /v2/datasets/{id}/lineage](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getlineage.md): Retrieves the specified dataset’s lineage, including upstream data sources and datasets and downstream datasets and metrics.
 - [GET /v2/datasets/{id}/metadata](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getmetadata.md): Retrieves metadata configured for the specified dataset.
 - [PATCH /v2/datasets/{id}/metadata](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_updatemetadata.md): Updates metadata for the specified dataset and returns the updated metadata.
 - [GET /v2/datasets/{id}/modifications](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getmodification.md): Retrieves the modification configured for the specified dataset.
 - [PUT /v2/datasets/{id}/modifications](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_updatemodification.md): Replaces the modification configured for the specified dataset.
 - [DELETE /v2/datasets/{id}/modifications](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_deletemodification.md): Deletes the modification configured for the specified dataset.
 - [POST /v2/datasets/{id}/modifications/preview](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_previewmodification.md): Applies the supplied modification settings and returns a preview without saving the changes.
 - [GET /v2/datasets/{id}/permissions](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getpermissions.md): Retrieves the permissions configured for the specified dataset.
 - [PUT /v2/datasets/{id}/permissions](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_updatepermissions.md): Replaces the permissions configured for the specified dataset.
 - [POST /v2/datasets/{id}/purge](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_purgedataset.md): Permanently removes all stored records from the specified dataset without deleting the dataset.
 - [GET /v2/datasets/{id}/schema](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getschema.md): Retrieves the column definitions for the specified dataset.
 - [PUT /v2/datasets/{id}/sync-frequency](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_updatesyncfrequency.md): Updates the scheduled sync frequency for the specified dataset.
 - [GET /v2/datasets/{id}/sync-frequency-options](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getsyncfrequencyoptions.md): Retrieves the sync frequencies available for the specified dataset.
 - [GET /v2/datasets/{id}/sync-history](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getsynchistory.md): Retrieves a paginated history of sync attempts for the specified dataset.
 - [GET /v2/datasets/{id}/sync-history/statistics](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getsyncstatistics.md): Retrieves sync performance statistics for the specified dataset.
 - [PUT /v2/datasets/{id}/timezone](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_updatetimezone.md): Updates the time zone used by the specified dataset.
 - [GET /v2/datasets/{id}/verification](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_getverification.md): Retrieves the verification status of the specified dataset.
 - [PUT /v2/datasets/{id}/verification](https://developers.databox.com/docs/api/api.databox.com/datasets/datasets_updateverification.md): Updates the verification status of the specified dataset.
## Integrations

 - [GET /v2/integrations](https://developers.databox.com/docs/api/api.databox.com/integrations/integrations_getintegrations.md): Retrieves a paginated list of all available integrations.
 - [GET /v2/integrations/{id}](https://developers.databox.com/docs/api/api.databox.com/integrations/integrations_getintegrationbyid.md): Retrieves details about a specific integration.
## Metrics

 - [GET /v2/metrics](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_listmetrics.md): Retrieves a paginated list of metrics in the organization.
 - [POST /v2/metrics](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_createmetric.md): Creates a metric from the specified dataset and metric configuration.
 - [POST /v2/metrics/dimensions/values](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_getdimensionvalues.md): Retrieves the available dimension values for one or more metrics.
 - [POST /v2/metrics/drilldown](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_getdrilldowndata.md): Retrieves the underlying records for a metric within a specified period.
 - [GET /v2/metrics/{id}](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_getmetric.md): Retrieves details about a specific metric.
 - [PATCH /v2/metrics/{id}](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_updatemetric.md): Updates the configuration of a specific metric.
 - [DELETE /v2/metrics/{id}](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_deletemetric.md): Deletes a specific metric from the organization.
 - [GET /v2/metrics/{id}/lineage](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_getlineage.md): Retrieves the specified metric's lineage, including upstream data sources and datasets and metrics.
 - [GET /v2/metrics/{id}/usages](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_getmetricusages.md): Retrieves the locations where a specific metric is used.
 - [GET /v2/metrics/{id}/verification](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_getverification.md): Retrieves the verification status and details for a specific metric.
 - [PUT /v2/metrics/{id}/verification](https://developers.databox.com/docs/api/api.databox.com/metrics/metrics_updateverification.md): Updates the verification status of a specific metric.
## Organization

 - [GET /v2/organization](https://developers.databox.com/docs/api/api.databox.com/organization/organization_getorganization.md): Retrieves details about the organization associated with the authenticated user.
 - [PATCH /v2/organization](https://developers.databox.com/docs/api/api.databox.com/organization/organization_updateorganization.md): Updates details and settings for the organization associated with the authenticated user.
 - [GET /v2/organization/activity-log](https://developers.databox.com/docs/api/api.databox.com/organization/organization_getactivitylog.md): Retrieves a paginated list of activity recorded within the organization.
 - [GET /v2/organization/countries](https://developers.databox.com/docs/api/api.databox.com/organization/organization_getcountries.md): Retrieves the list of available countries and their country codes.
 - [GET /v2/organization/metadata-options](https://developers.databox.com/docs/api/api.databox.com/organization/organization_getmetadataoptions.md): Retrieves the available business classification, industry, company size, and annual revenue options for populating the organization's metadata.
 - [GET /v2/organization/timezones](https://developers.databox.com/docs/api/api.databox.com/organization/organization_gettimezones.md): Retrieves the list of all time zones supported by Databox, including their UTC offsets and IANA identifiers.
 - [GET /v2/organization/usage](https://developers.databox.com/docs/api/api.databox.com/organization/organization_getorganizationusage.md): Retrieves current usage and limits for resources within the organization associated with the authenticated user.
## Profile

 - [GET /v2/profile](https://developers.databox.com/docs/api/api.databox.com/profile/profile_getprofile.md): Retrieves profile information for the authenticated user.
 - [PATCH /v2/profile](https://developers.databox.com/docs/api/api.databox.com/profile/profile_updateprofile.md): Updates profile information for the authenticated user.
 - [GET /v2/profile/metadata-options](https://developers.databox.com/docs/api/api.databox.com/profile/profile_getmetadataoptions.md): Retrieves the available department and role options for populating a user's profile metadata.
## Users

 - [GET /v2/users](https://developers.databox.com/docs/api/api.databox.com/users/users_getusers.md): Retrieves a paginated list of users associated with the organization.
 - [POST /v2/users](https://developers.databox.com/docs/api/api.databox.com/users/users_createuser.md): Creates a user in the organization.
 - [GET /v2/users/{id}](https://developers.databox.com/docs/api/api.databox.com/users/users_getuserbyid.md): Retrieves details about a specific user.
 - [PATCH /v2/users/{id}](https://developers.databox.com/docs/api/api.databox.com/users/users_updateuser.md): Updates information for a specific user.
 - [DELETE /v2/users/{id}](https://developers.databox.com/docs/api/api.databox.com/users/users_deleteuser.md): Deletes a specific user from the organization.