Cloudera

Cloudera Data Warehouse API

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.

GitHub OpenAPI

Operations 95

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 the status. Once it is de #
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 latest status of a Data V #
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 the latest status of a Da #
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. #
POST /api/v1/dw/suspendVw Suspends a running Virtual Warehouse. #
POST /api/v1/dw/createVwDiagnosticDataJob Create a diagnostic job for the given Virtual Warehouse. #
POST /api/v1/dw/listVwDiagnosticDataJobs Get a list of diagnostic jobs for the given Virtual Warehouse. #
POST /api/v1/dw/describeVwDiagnosticDataJob Describe a diagnostic jobs for the given Virtual Warehouse. #
POST /api/v1/dw/deleteVwDiagnosticDataJob Delete a diagnostic job for the given Virtual Warehouse. #
POST /api/v1/dw/listVwEvents Get the list of events for the given Virtual Warehouse. #
POST /api/v1/dw/listLatestVersions Lists the latest version of the product (if available) for all catalogs in the environment. #
POST /api/v1/dw/describeVwConfig Describes the current configuration of a Hive or Impala Virtual Warehouse. #
POST /api/v1/dw/describeConfig Describe a service configuration. #
POST /api/v1/dw/describeConfigDiff Get differences between two service configurations. #
POST /api/v1/dw/listDbcConfigs Get the configuration history of a Database Catalog. #
POST /api/v1/dw/listVwConfigs Get the configuration history of a Virtual Warehouse. #
POST /api/v1/dw/updateVw Update the configuration of a Virtual Warehouse. #
POST /api/v1/dw/updateDbc Update the configuration of a Database Catalog. #
POST /api/v1/dw/addUser Adds the given user to the cluster. #
POST /api/v1/dw/deleteUser Deletes the given user from the cluster. #
POST /api/v1/dw/listUsers Lists the users who have access to the cluster. #
POST /api/v1/dw/upgradeDbc Upgrades the Database Catalog to a compatible version. #
POST /api/v1/dw/upgradeVw Upgrades the Virtual Warehouse to a compatible version. #
POST /api/v1/dw/getUpgradeVwVersions Gets the latest version and latest compatible version for Virtual Warehouse. #
POST /api/v1/dw/getUpgradeDbcVersions Gets the latest version and latest compatible version for Database Catalog. #
POST /api/v1/dw/healthCheck Check the health of the API. #
POST /api/v1/dw/createBackup Creates a backup for the data warehouse. #
POST /api/v1/dw/deleteBackup Deletes a data warehouse backup. #
POST /api/v1/dw/describeBackup Describes the backup. #
POST /api/v1/dw/restoreBackup Restores backup. #
POST /api/v1/dw/describeRestore Describes the restore. #
POST /api/v1/dw/listBackupEntities Lists potential backup entities associated with the data warehouse. #
POST /api/v1/dw/listBackups Lists backups. #
POST /api/v1/dw/listRestores Lists restores. #
POST /api/v1/dw/getLogs Gets job logs. #
POST /api/v1/dw/listResourceTemplates Get default resource allocation templates. #
POST /api/v1/dw/createResourceTemplate Create a resource allocation template. #
POST /api/v1/dw/updateResourceTemplate Update a resource allocation template. #
POST /api/v1/dw/deleteResourceTemplate Delete a resource allocation template. #

Documentation

📖
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/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-dw-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/overlays/cloudera-dw-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cloudera-datawarehouse-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudera-dw-openapi.yml Raw ↑ 
swagger: '2.0'
x-endpoint-name: dw
x-products: CDP
x-form-factors: public,private
x-cdp-releases: PUBLIC
info:
  version: 0.9.163
  title: Cloudera Data Warehouse [EXPERIMENTAL]
  license:
    name: Apache 2.0
  description: Install and manage Cloudera Data Warehouse clusters.
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /api/v1/dw/listClusters:
    post:
      x-no-compatibility-guarantee: true
      summary: List Cloudera Data Warehouse clusters.
      description: List Cloudera Data Warehouse clusters.
      operationId: listClusters
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListClustersRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListClustersResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/dw/describeCluster:
    post:
      x-no-compatibility-guarantee: true
      summary: Describe a Cloudera Data Warehouse cluster.
      description: Describe a Cloudera Data Warehouse cluster.
      operationId: describeCluster
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/dw/createClusterDiagnosticDataJob:
    post:
      x-mutating: true
      x-form-factors: public
      summary: Create a diagnostic job for the given cluster.
      description: Creates a diagnostic job for the given cluster. The diagnostic data job is useful for troubleshooting purposes. The job collects logs and metrics (see --download-options to see available options) which are going to be bundled into a single file and will be available at the desired location (see --destination). General metadata about the diagnostics will also be included as the bundle-info.json file.
      operationId: createClusterDiagnosticDataJob
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateClusterDiagnosticDataJobRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateClusterDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/listClusterDiagnosticDataJobs:
    post:
      x-mutating: false
      x-paging-default-max-items: 100
      x-form-factors: public
      summary: Get a list of diagnostic jobs for the given cluster.
      description: Lists diagnostic jobs for the given cluster. The output includes a list of jobs along with their current status and metadata related to each job.
      operationId: listClusterDiagnosticDataJobs
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListClusterDiagnosticDataJobsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListClusterDiagnosticDataJobsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/describeClusterDiagnosticDataJob:
    post:
      x-mutating: false
      x-form-factors: public
      summary: Describes a diagnostic job for the given Cluster.
      description: Describes a diagnostic job for the given Cluster. The output includes a list of jobs along with their current status and some metadata related to each job.
      operationId: describeClusterDiagnosticDataJob
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeClusterDiagnosticDataJobRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeClusterDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/deleteClusterDiagnosticDataJob:
    post:
      x-mutating: true
      x-form-factors: public
      summary: Deletes a diagnostic job for the given cluster.
      description: Deletes a diagnostic job for the given cluster. The job can be deleted even when its status is "Running".
      operationId: deleteClusterDiagnosticDataJob
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteClusterDiagnosticDataJobRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteClusterDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/describeKubeconfig:
    post:
      x-form-factors: public
      summary: Get Kubeconfig for a Cloudera Data Warehouse cluster.
      description: Get Kubeconfig for a Cloudera Data Warehouse cluster.
      operationId: describeKubeconfig
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeKubeconfigRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeKubeconfigResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/dw/describeAllowedInstanceTypes:
    post:
      x-mutating: false
      x-form-factors: public
      summary: Get allowed compute instance types for both AWS and Azure cluster types and their default values.
      description: Get allowed compute instance types for both AWS and Azure cluster types and their default values.
      operationId: describeAllowedInstanceTypes
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeAllowedInstanceTypesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeAllowedInstanceTypesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/describeServerSetting:
    post:
      x-form-factors: private
      summary: Get the DWX server settings.
      description: Get the DWX server settings. This method can be used from DWX Private Cloud version 1.4.1.
      operationId: describeServerSetting
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeServerSettingRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeServerSettingResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/dw/updateServerSetting:
    post:
      x-form-factors: private
      summary: Update the DWX server settings.
      description: 'Update the DWX server settings. The input list of server settings will be updated accordingly (turns on if enabled: true is set, turns off if enabled: false is set). Some settings need further actions to be taken (e.g. recreating a Virtual Warehouse), this is indicated in the server setting list returned by the describeServerSetting functionality. This method can be used from DWX Private Cloud version 1.4.1.'
      operationId: updateServerSetting
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateServerSettingRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateServerSettingResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/dw/resetServerSettings:
    post:
      x-form-factors: private
      summary: Restores the DWX server settings to the default values.
      description: Restores the DWX server settings to the default values. Some settings need further actions to be taken (e.g. recreating a Virtual Warehouse), this is indicated in the server settings list returned by the describeServerSetting functionality.
      operationId: resetServerSettings
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ResetServerSettingsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ResetServerSettingsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/dw/listEvents:
    post:
      x-form-factors: public,private
      x-mutating: false
      summary: Get the list of events.
      description: 'Get the list of events for the given Operation or a specific Service (Cluster, Database Catalog, Virtual Warehouse, or Data Visualization App). Events can belong to a particular Operation which might span across multiple Services. This happens if the given operation affects one or more Services e.g.: restore-cluster. It is also possible to return the events only for a given Service, in this case it is enough to pass the Id of a Service (e.g.: env-sq7hfv, warehouse-1696571829-pps2, compute-1696571962-8dd8, impala-1696572085-cn44).'
      operationId: listEvents
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListEventsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListEventsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/updateSshKey:
    post:
      x-form-factors: public
      summary: Update the SSH Key for a Cloudera Data Warehouse cluster
      description: Update the SSH Key for a Cloudera Data Warehouse cluster
      operationId: updateSshKey
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateSshKeyRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateSshKeyResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/dw/renewCertificates:
    post:
      summary: Renew certificates for a Cloudera Data Warehouse public cloud cluster.
      description: Renew certificate for a Cloudera Data Warehouse public cloud cluster.
      operationId: renewCertificates
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RenewCertificatesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RenewCertificatesResponse'
        405:
          description: Operation not allowed on non-public cloud clusters.
          schema:
            $ref: '#/definitions/Error'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/dw/createCluster:
    post:
      x-no-compatibility-guarantee: true
      summary: Create a Cloudera Data Warehouse cluster.
      description: Create a Cloudera Data Warehouse cluster.
      operationId: createCluster
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/dw/createAwsCluster:
    post:
      x-mutating: true
      summary: Create an AWS cluster in the Cloudera Data Warehouse.
      description: Create an AWS cluster in the Cloudera Data Warehouse environment with the provided settings.
      operationId: createAwsCluster
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateAwsClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateAwsClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/createAzureCluster:
    post:
      x-mutating: true
      summary: Create an Azure cluster in the Cloudera Data Warehouse.
      description: Create an Azure cluster in the Cloudera Data Warehouse environment with the provided settings.
      operationId: createAzureCluster
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateAzureClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateAzureClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/createPrivateCluster:
    post:
      x-form-factors: private
      x-no-compatibility-guarantee: true
      x-mutating: true
      summary: Create a  a Private Cloud cluster in the Cloudera Data Warehouse.
      description: Create a Private Cloud cluster in the Cloudera Data Warehouse environment with the provided settings.
      operationId: createPrivateCluster
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreatePrivateClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreatePrivateClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/deleteCluster:
    post:
      x-no-compatibility-guarantee: true
      summary: Delete a Cloudera Data Warehouse cluster.
      description: Delete a Cloudera Data Warehouse cluster.
      operationId: deleteCluster
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/dw/updateCluster:
    post:
      x-mutating: true
      summary: Updates the Cloudera Data Warehouse cluster.
      description: Update the Cloudera Data Warehouse cluster.
      operationId: updateCluster
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/backupCluster:
    post:
      x-mutating: true
      x-no-compatibility-guarantee: true
      summary: Creates a backup from the cluster configuration and settings.
      description: Creates a backup from the configuration and settings, including all the connected DbCatalogs, Virtual Warehouses and Data Visualisation Apps. The returned data may be used to restore all the entities by using the "restore-cluster" command. The CDW doesn't provide centralized management of the backups. Learn more at https://docs.cloudera.com/data-warehouse/cloud/backup-and-restore/topics/dw-environment-reactivation.html
      operationId: backupCluster
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/BackupClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/BackupClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/restoreCluster:
    post:
      x-mutating: true
      x-no-compatibility-guarantee: true
      summary: Restores the cluster from a backup data made by "backup-cluster" command.
      description: Restores the cluster from a backup data made by "backup-cluster" command. The operation restores the default DbCatalog configuration, the Virtual Warehouses and the Data Visualisation Apps. Learn more at https://docs.cloudera.com/data-warehouse/cloud/backup-and-restore/topics/dw-environment-reactivation.html
      operationId: restoreCluster
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RestoreClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RestoreClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/createDataVisualization:
    post:
      summary: Creates a Cloudera Data Visualization.
      description: Creates a Cloudera Data Visualization.
      operationId: createDataVisualization
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateDataVisualizationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateDataVisualizationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/dw/listDataVisualizations:
    post:
      summary: Lists Cloudera Data Visualization in the provided CDW cluster.
      description: Lists Cloudera Data Visualization in the provided CDW cluster.
      operationId: listDataVisualizations
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListDataVisualizationsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListDataVisualizationsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/dw/deleteDataVisualization:
    post:
      summary: Asynchronous operation that deletes a Cloudera Data Visualization. When the DV is in deleting state, we can still use describe-data-visualization to check the status. Once it is deleted, the describe-data-visualization would return a not found error.
      description: Asynchronous operation that deletes a Cloudera Data Visualization. When the DV is in deleting state, we can still use describe-data-visualization to check the status. Once it is deleted, the describe-data-visualization would return a not found error.
      operationId: deleteDataVisualization
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteDataVisualizationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteDataVisualizationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/dw/describeDataVisualization:
    post:
      summary: Describes a Cloudera Data Visualization.
      description: Describes a Cloudera Data Visualization.
      operationId: describeDataVisualization
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeDataVisualizationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeDataVisualizationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/dw/updateDataVisualization:
    post:
      x-mutating: true
      summary: Asynchronous operation that updates the configuration of a Cloudera Data Visualization. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.
      description: Asynchronous operation that updates the configuration of a Cloudera Data Visualization. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.
      operationId: updateDataVisualization
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateDataVisualizationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateDataVisualizationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/getDataVisualizationUpgradeVersion:
    post:
      summary: Gets latest version and latest compatible version for Cloudera Data Visualization.
      description: Gets latest version and latest compatible version for Cloudera Data Visualization.
      operationId: getDataVisualizationUpgradeVersion
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetDataVisualizationUpgradeVersionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetDataVisualizationUpgradeVersionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/dw/upgradeDataVisualization:
    post:
      summary: Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.
      description: Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.
      operationId: upgradeDataVisualization
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpgradeDataVisualizationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpgradeDataVisualizationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/dw/registerSecret:
    post:
      x-form-factors: public
      x-mutating: true
      summary: Registers a reference to a secret stored in the vault of the cloud provider.
      description: Registers a reference to a secret stored in the vault of the cloud provider and stores its metadata in the database. The secret is used to connect to an external data source.
      operationId: registerSecret
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RegisterSecretRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RegisterSecretResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/createSecret:
    post:
      x-form-factors: private
      x-mutating: true
      summary: Creates a secret in the user's kubernetes cluster.
      description: Creates a secret in the user's kubernetes cluster and stores its metadata in the database. The secret is used to connect to an external data source.
      operationId: createSecret
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateSecretRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateSecretResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/listSecrets:
    post:
      x-form-factors: public,private
      x-mutating: false
      summary: Lists all secrets.
      description: Lists all the cloud provider secrets in a particular environment.
      operationId: listSecrets
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListSecretsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListSecretsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/deleteSecret:
    post:
      x-form-factors: public,private
      x-mutating: true
      summary: Deletes a secret.
      description: Deletes a secret from the database.
      operationId: deleteSecret
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteSecretRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteSecretResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/dw/createConnector:
    post:
      x-no-compatibility-guarantee: true
      summary: Creates a Connector
      description: Creates a new Connector in the specified cluster.
      operationId: createConnector
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateConnectorRequest'
      responses:
        '200':
          description: Connector created successfully.
          schema:
            $ref: '#/definitions/CreateConnectorResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
      x-form-factors: public,private
  /api/v1/dw/createConnectorTestJob:
    post:
      x-no-compatibility-guarantee: true
      summary: Test Trino Connector in a CDW cluster.
      description: Test Trino Connector in a CDW cluster.
      operationId: createConnectorTestJob
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateConnectorTestJobRequest'
      responses:
        '200':
          description: Connection test job created
          schema:
            $ref: '#/definitions/CreateConnectorTestJobResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
      x-form-factors: public,private
  /api/v1/dw/listConnectorTestJobs:
    post:
      x-no-compatibility-guarantee: true
      summary: List test connector jobs.
      description: List test connector jobs.
      operationId: listConnectorTestJobs
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListConnectorTestJobsRequest'
      responses:
        '200':
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListConnectorTestJobsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
      x-form-factors: public,private
  /api/v1/dw/listConnectors:
    post:
      x-no-compatibility-guarantee: true
      summary: Lists Database Connectors.
      description: Lists Database Connectors.
      operationId: listConnectors
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListConnectorsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListConnectorsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
      x-form-factors: public,private
  /api/v1/dw/deleteConnector:
    post:
      x-no-compatibility-guarantee: true
      summary: Deletes a Database connector.
      description: Deletes a Database connector.
      operationId: deleteConnector
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteConnectorRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteConnectorResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
      x-form-factors: public,private
  /api/v1/dw/updateConnector:
    post:
      x-mutating: true
      x-form-factors: public,private
      summary: Updates the Cloudera Data Warehouse connector.
      description: Update the Cloudera Data Warehouse connector.
      operationId: updateConnector
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateConnectorRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
      

# --- truncated at 32 KB (262 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-dw-openapi.yml