# Cloudera Data Warehouse API

**Canonical:** https://apis.io/apis/cloudera/cloudera-datawarehouse-api/  
**Provider:** Cloudera — https://apis.io/providers/cloudera/  
**Base URL:** https://api.us-west-1.cdp.cloudera.com  
**Documentation:** https://docs.cloudera.com/cdp-public-cloud/cloud/api/topics/mc-api-overview.html

Cloudera Data Warehouse API is one of 24 APIs that [Cloudera](https://apis.io/providers/cloudera/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Data Warehouse, SQL, and Analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The largest service in the CDP contract — activate DW clusters on an environment and manage database catalogs, virtual warehouses, backups and events. 95 operations. Marked EXPERIMENTAL by Cloudera.

## Operations (60 of 95)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/dw/listClusters` | List Cloudera Data Warehouse clusters. |
| POST | `/api/v1/dw/describeCluster` | Describe a Cloudera Data Warehouse cluster. |
| POST | `/api/v1/dw/createClusterDiagnosticDataJob` | Create a diagnostic job for the given cluster. |
| POST | `/api/v1/dw/listClusterDiagnosticDataJobs` | Get a list of diagnostic jobs for the given cluster. |
| POST | `/api/v1/dw/describeClusterDiagnosticDataJob` | Describes a diagnostic job for the given Cluster. |
| POST | `/api/v1/dw/deleteClusterDiagnosticDataJob` | Deletes a diagnostic job for the given cluster. |
| POST | `/api/v1/dw/describeKubeconfig` | Get Kubeconfig for a Cloudera Data Warehouse cluster. |
| POST | `/api/v1/dw/describeAllowedInstanceTypes` | Get allowed compute instance types for both AWS and Azure cluster types and their default values. |
| POST | `/api/v1/dw/describeServerSetting` | Get the DWX server settings. |
| POST | `/api/v1/dw/updateServerSetting` | Update the DWX server settings. |
| POST | `/api/v1/dw/resetServerSettings` | Restores the DWX server settings to the default values. |
| POST | `/api/v1/dw/listEvents` | Get the list of events. |
| POST | `/api/v1/dw/updateSshKey` | Update the SSH Key for a Cloudera Data Warehouse cluster |
| POST | `/api/v1/dw/renewCertificates` | Renew certificates for a Cloudera Data Warehouse public cloud cluster. |
| POST | `/api/v1/dw/createCluster` | Create a Cloudera Data Warehouse cluster. |
| POST | `/api/v1/dw/createAwsCluster` | Create an AWS cluster in the Cloudera Data Warehouse. |
| POST | `/api/v1/dw/createAzureCluster` | Create an Azure cluster in the Cloudera Data Warehouse. |
| POST | `/api/v1/dw/createPrivateCluster` | Create a a Private Cloud cluster in the Cloudera Data Warehouse. |
| POST | `/api/v1/dw/deleteCluster` | Delete a Cloudera Data Warehouse cluster. |
| POST | `/api/v1/dw/updateCluster` | Updates the Cloudera Data Warehouse cluster. |
| POST | `/api/v1/dw/backupCluster` | Creates a backup from the cluster configuration and settings. |
| POST | `/api/v1/dw/restoreCluster` | Restores the cluster from a backup data made by "backup-cluster" command. |
| POST | `/api/v1/dw/createDataVisualization` | Creates a Cloudera Data Visualization. |
| POST | `/api/v1/dw/listDataVisualizations` | Lists Cloudera Data Visualization in the provided CDW cluster. |
| POST | `/api/v1/dw/deleteDataVisualization` | Asynchronous operation that deletes a Cloudera Data Visualization. When the DV is in deleting state, we can still use describe-data-visualization to check th... |
| POST | `/api/v1/dw/describeDataVisualization` | Describes a Cloudera Data Visualization. |
| POST | `/api/v1/dw/updateDataVisualization` | Asynchronous operation that updates the configuration of a Cloudera Data Visualization. The describe-data-visualization can be used at any time to get the la... |
| POST | `/api/v1/dw/getDataVisualizationUpgradeVersion` | Gets latest version and latest compatible version for Cloudera Data Visualization. |
| POST | `/api/v1/dw/upgradeDataVisualization` | Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get th... |
| POST | `/api/v1/dw/registerSecret` | Registers a reference to a secret stored in the vault of the cloud provider. |
| POST | `/api/v1/dw/createSecret` | Creates a secret in the user's kubernetes cluster. |
| POST | `/api/v1/dw/listSecrets` | Lists all secrets. |
| POST | `/api/v1/dw/deleteSecret` | Deletes a secret. |
| POST | `/api/v1/dw/createConnector` | Creates a Connector |
| POST | `/api/v1/dw/createConnectorTestJob` | Test Trino Connector in a CDW cluster. |
| POST | `/api/v1/dw/listConnectorTestJobs` | List test connector jobs. |
| POST | `/api/v1/dw/listConnectors` | Lists Database Connectors. |
| POST | `/api/v1/dw/deleteConnector` | Deletes a Database connector. |
| POST | `/api/v1/dw/updateConnector` | Updates the Cloudera Data Warehouse connector. |
| POST | `/api/v1/dw/createDbc` | Create a Database Catalog. |
| POST | `/api/v1/dw/listDbcs` | List Database Catalogs. |
| POST | `/api/v1/dw/describeDbc` | Describe a Database Catalog. |
| POST | `/api/v1/dw/deleteDbc` | Delete a Database Catalog. |
| POST | `/api/v1/dw/rebuildDbc` | Rebuild a Database Catalog. |
| POST | `/api/v1/dw/suspendDbc` | Suspends a running Database Catalog. |
| POST | `/api/v1/dw/startDbc` | Start a Database Catalog. |
| POST | `/api/v1/dw/describeDbcConfig` | Describes the Database Catalog current configuration. |
| POST | `/api/v1/dw/updateDbcConfig` | Update a Database Catalog configuration. |
| POST | `/api/v1/dw/createDbcDiagnosticDataJob` | Create a diagnostic job for the given database catalog. |
| POST | `/api/v1/dw/listDbcDiagnosticDataJobs` | Get a list of diagnostic jobs for the given Database Catalog. |
| POST | `/api/v1/dw/describeDbcDiagnosticDataJob` | Describes a diagnostic job for the given Database Catalog. |
| POST | `/api/v1/dw/deleteDbcDiagnosticDataJob` | Deletes a diagnostic job for the given Database Catalog. |
| POST | `/api/v1/dw/listDbcEvents` | Get the list of events for the given Database Catalog. |
| POST | `/api/v1/dw/createVw` | Create a Virtual Warehouse. |
| POST | `/api/v1/dw/listVws` | List Virtual Warehouses. |
| POST | `/api/v1/dw/describeVw` | Describe a Virtual Warehouse. |
| POST | `/api/v1/dw/updateVwConfig` | Update a Virtual Warehouse configuration. |
| POST | `/api/v1/dw/deleteVw` | Delete a Virtual Warehouse. |
| POST | `/api/v1/dw/rebuildVw` | Rebuild a Virtual Warehouse. |
| POST | `/api/v1/dw/startVw` | Starts a suspended Virtual Warehouse. |

…and 35 more operations. They are listed in full on the page.

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-dw-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/overlays/cloudera-dw-overlay.yaml
- **Documentation** — https://docs.cloudera.com/cdp-public-cloud/cloud/api/topics/mc-api-overview.html
- **APIReference** — https://cloudera.github.io/cdp-dev-docs/api-docs/

## Other Cloudera APIs (12)

- [Cloudera Audit Service API](https://apis.io/apis/cloudera/cloudera-audit-api/)
- [Cloudera Private Links API](https://apis.io/apis/cloudera/cloudera-cloudprivatelinks-api/)
- [Cloudera Compute Service API](https://apis.io/apis/cloudera/cloudera-compute-api/)
- [Cloudera Consumption API](https://apis.io/apis/cloudera/cloudera-consumption-api/)
- [Cloudera Data Catalog API](https://apis.io/apis/cloudera/cloudera-datacatalog-api/)
- [Cloudera Data Hub API](https://apis.io/apis/cloudera/cloudera-datahub-api/)
- [Cloudera Datalake API](https://apis.io/apis/cloudera/cloudera-datalake-api/)
- [Cloudera Data Engineering API](https://apis.io/apis/cloudera/cloudera-dataengineering-api/)
- [Cloudera DataFlow API](https://apis.io/apis/cloudera/cloudera-dataflow-api/)
- [Cloudera DataFlow Workload API](https://apis.io/apis/cloudera/cloudera-dataflow-workload-api/)
- [Cloudera Control Plane Data Recovery API](https://apis.io/apis/cloudera/cloudera-datarecovery-api/)
- [Cloudera Environments API](https://apis.io/apis/cloudera/cloudera-environments-api/)

## Tags

Data Warehouse, SQL, Analytics

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cloudera/cloudera-datawarehouse-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cloudera/.
