Cloudera

Cloudera Environments API

The tenancy root of CDP. Register cloud credentials and create, describe and delete environments on AWS, Azure, GCP and AWS GovCloud, including FreeIPA, proxies, telemetry and audit credentials. 104 operations and the most referenced identifier in the whole contract.

GitHub OpenAPI

Operations 104

POST /api/v1/environments2/getCredentialPrerequisites This API provides the credential prerequisites for the given cloud provider. #
POST /api/v1/environments2/getGovCloudCredentialPrerequisites This API provides the credential prerequisites for GovCloud for the enabled providers. #
POST /api/v1/environments2/createAWSEnvironment Creates a new AWS environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created. #
POST /api/v1/environments2/createAWSGovCloudEnvironment Creates a new AWS GovCloud environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is cre #
POST /api/v1/environments2/createAzureEnvironment Creates a new Azure environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created. #
POST /api/v1/environments2/createGCPEnvironment Creates a new GCP environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created. #
POST /api/v1/environments2/createPrivateEnvironment Creates a new Private Cloud environment by providing the Cloudera Manager address and credentials. #
POST /api/v1/environments2/createAWSCredential Creates a new AWS credential that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud pr #
POST /api/v1/environments2/createAWSGovCloudCredential Creates a new AWS credential for GovCloud that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within #
POST /api/v1/environments2/createAzureCredential Creates a new Azure credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud p #
POST /api/v1/environments2/updateAzureCredential Updates a new certificate based Azure credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances w #
POST /api/v1/environments2/updateAwsCredential Updates an AWS credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provid #
POST /api/v1/environments2/createGCPCredential Creates a new GCP credential that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud pr #
POST /api/v1/environments2/changeEnvironmentCredential Changes the credential for an environment. #
POST /api/v1/environments2/updateAzureEncryptionResources Update the Azure encryption resources for the environment. #
POST /api/v1/environments2/updateAzureDatabaseResources Update the Azure database resources for the environment. #
POST /api/v1/environments2/updateAzureAvailabilityZones Update the Availability Zones for the Azure environment. #
POST /api/v1/environments2/updateAwsDiskEncryptionParameters Update the AWS encryption key ARN for the environment. #
POST /api/v1/environments2/deleteEnvironment Deletes an environment. #
POST /api/v1/environments2/deleteCredential Deletes a credential. #
POST /api/v1/environments2/listEnvironments Lists environments. #
POST /api/v1/environments2/listCredentials Lists credentials. #
POST /api/v1/environments2/describeEnvironment Describes an environment. #
POST /api/v1/environments2/syncAllUsers Synchronizes environments with all users and groups state with CDP. #
POST /api/v1/environments2/syncUser Synchronizes environments with single user to the FreeIPA servers. #
POST /api/v1/environments2/syncStatus Returns status of the sync operation for the operation id. #
POST /api/v1/environments2/lastSyncStatus Returns status of the sync operation for the environment crn. #
POST /api/v1/environments2/listConnectedDataServices Returns the list of Data Services and their cluster names that are attached the given environment. #
POST /api/v1/environments2/getEnvironmentUserSyncState Returns the user synchronization state for an environment. #
POST /api/v1/environments2/setPassword Sets workload user's password and updates into all environments. #
POST /api/v1/environments2/getRootCertificate This API provides contents of public certificate for an environment. #
POST /api/v1/environments2/getKeytab Retrieves a keytab for a user or machine user. #
POST /api/v1/environments2/getAutomatedSyncEnvironmentStatus Gets the the automated sync status for the environment. #
POST /api/v1/environments2/getIdBrokerMappings Gets all ID Broker mappings for an environment. #
POST /api/v1/environments2/setIdBrokerMappings Sets all ID Broker mappings for an environment. #
POST /api/v1/environments2/syncIdBrokerMappings Syncs all ID Broker mappings for an environment. #
POST /api/v1/environments2/getIdBrokerMappingsSyncStatus Gets ID Broker mappings sync status. #
POST /api/v1/environments2/startEnvironment Start an environment. #
POST /api/v1/environments2/stopEnvironment Stop an environment. #
POST /api/v1/environments2/getOperation Get the latest (in progress or finished) operation for the environment resource. #
POST /api/v1/environments2/checkEnvironmentConnectivity Checks connectivity to a new Private Cloud environment by trying to access the Cloudera Manager address with provided credentials. #
POST /api/v1/environments2/checkDatabaseConnectivity Checks Database connectivity based on the input parameters. #
POST /api/v1/environments2/checkKubernetesConnectivity Checks connectivity to a Kubernetes address with provided kubeconfig files. #
POST /api/v1/environments2/getFreeipaStatus Get the status of the FreeIPA services #
POST /api/v1/environments2/attachFreeIpaRecipes Attach recipes to FreeIPA. #
POST /api/v1/environments2/detachFreeIpaRecipes Detach recipes from FreeIPA. #
POST /api/v1/environments2/repairFreeipa Repairs the FreeIPA nodes. #
POST /api/v1/environments2/getRepairFreeipaStatus Returns status of the repair operation for the operation id. #
POST /api/v1/environments2/createProxyConfig Creates a new proxy config that can be attatched to an environment. #
POST /api/v1/environments2/listProxyConfigs Lists proxy configs. #
POST /api/v1/environments2/deleteProxyConfig Deletes a proxy config. #
POST /api/v1/environments2/setTelemetryFeatures Configure environment level telemetry feature setting. #
POST /api/v1/environments2/getEnvironmentSetting Read a configuration setting from the environment service. #
POST /api/v1/environments2/setEnvironmentSetting Read a configuration setting from the environment service. #
POST /api/v1/environments2/setAccountTelemetry Set account level telemetry settings. (telemetry features and anonymization rules) #
POST /api/v1/environments2/getAccountTelemetry Get account level telemetry settings. (telemetry features and anonymization rules) #
POST /api/v1/environments2/getAccountTelemetryDefault Get default account level telemetry settings. Helps to set back the default values. #
POST /api/v1/environments2/testAccountTelemetryRules Test anonymization rules (for account telemetry) against text input. #
POST /api/v1/environments2/getFreeipaLogDescriptors Gather log descriptors that are used for diagnostics collection. #
POST /api/v1/environments2/collectFreeipaDiagnostics Start FreeIPA diagnostics collection #
POST /api/v1/environments2/listFreeipaDiagnostics List recent FreeIPA diagnostics collections #
POST /api/v1/environments2/cancelFreeipaDiagnostics Cancel running FreeIPA diagnostics collections #
POST /api/v1/environments2/getAuditCredentialPrerequisites This API provides the audit credential prerequisites for the given cloud provider. #
POST /api/v1/environments2/getGovCloudAuditCredentialPrerequisites This API provides the audit credential prerequisites for GovCloud for the enabled providers. #
POST /api/v1/environments2/listAuditCredentials Lists audit credentials. #
POST /api/v1/environments2/setAWSAuditCredential Creates or updates the AWS audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage. #
POST /api/v1/environments2/setAWSGovCloudAuditCredential Creates or updates the AWS GovCloud audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage. #
POST /api/v1/environments2/setAzureAuditCredential Creates or updates the Azure audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage. #
POST /api/v1/environments2/setGCPAuditCredential Creates or updates the GCP audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage. #
POST /api/v1/environments2/deleteAuditCredential Deletes an audit credential. #
POST /api/v1/environments2/setEndpointAccessGateway Sets endpoint access gateway settings for the environment. #
POST /api/v1/environments2/updateSshKey Updates the designated SSH key for the given environment. The newly added SSH key will only be used for the Cloudera Data Hub clusters created within the environment after the new #
POST /api/v1/environments2/updateSubnet Updates the subnet(s) of the given environment. The newly added subnets will only be used for the Cloudera Data Hub clusters created within the environment after the new subnets we #
POST /api/v1/environments2/updateSecurityAccess Updates the security access settings of the given environment. The newly added security groups will only be used for the Cloudera Data Hub clusters created within the environment a #
POST /api/v1/environments2/updateTags Updates the user defined tags of the given environment. The newly added tags will only be used for the Cloudera Data Hub clusters created within the environment after the new tags #
POST /api/v1/environments2/validateAwsCloudStorage Validates AWS cloud storage settings of the given environment. #
POST /api/v1/environments2/validateAzureCloudStorage Validates Azure cloud storage settings of the given environment. #
POST /api/v1/environments2/setCatalog Sets a catalog for a FreeIPA installation. #
POST /api/v1/environments2/upgradeFreeipa Upgrades FreeIPA to the latest or defined image. #
POST /api/v1/environments2/getFreeipaUpgradeOptions Get available images for FreeIPA upgrade. #
POST /api/v1/environments2/upscaleFreeipa Upscales FreeIPA instances. #
POST /api/v1/environments2/downscaleFreeipa Downscales FreeIPA instances. #
POST /api/v1/environments2/retryFreeipa Retries the last failed operation on a FreeIPA. #
POST /api/v1/environments2/startFreeIpaVerticalScaling Initiates the vertical scaling on FreeIPA. #
POST /api/v1/environments2/upgradeCcm Upgrades Cluster Connectivity Manager on the environment to the latest available version. #
POST /api/v1/environments2/rotateSaltPassword Rotate SaltStack user password on FreeIPA instances. #
POST /api/v1/environments2/rotateFreeipaSecrets Rotate FreeIPA related secret for FreeIPA instances. #
POST /api/v1/environments2/listFreeipaSecretTypes Lists all FreeIPA related secret types. #
POST /api/v1/environments2/updateOrchestratorState Run orchestrator engine state update on the FreeIPA cluster. #
POST /api/v1/environments2/updateProxyConfig Updates the proxy config of the given environment. The newly added proxy configs will only be used for the Cloudera Data Hub clusters created within the environment after the new p #
POST /api/v1/environments2/updateAzureImageTermsPolicy Updates account level Azure Marketplace image policy. CDP is capable to automatically accept Azure Marketplace image terms during cluster deployment. You can use this setting in yo #
POST /api/v1/environments2/getAzureImageTermsPolicy Gets account level Azure Marketplace image policy. CDP is capable to automatically accept Azure Marketplace image terms during cluster deployment. You can use this setting in your #
POST /api/v1/environments2/updateDataServiceResources Updates Data Service resources of an environment. #
POST /api/v1/environments2/updateCustomDockerRegistry Updates custom docker registry CRN of an environment. #
POST /api/v1/environments2/updateFreeipaToAwsImdsV2 Updates FreeIPA AWS cluster to use IMDSv2. #
POST /api/v1/environments2/updateFreeipaToAwsImdsV1 Updates FreeIPA AWS cluster to use IMDSv1. #
POST /api/v1/environments2/initializeAWSComputeCluster Initialize compute cluster for AWS environment. #
POST /api/v1/environments2/initializeAzureComputeCluster Initialize compute cluster for Azure environment. #
POST /api/v1/environments2/setupActiveDirectoryTrust Setup cross-realm trust between FreeIPA and Active Directory. #
POST /api/v1/environments2/finishSetupTrust Complete cross-realm trust setup for FreeIPA. #
POST /api/v1/environments2/cancelTrust Cancel cross-realm trust for FreeIPA. #
POST /api/v1/environments2/repairTrust Repair cross-realm trust of FreeIPA with an Active Directory Server. #
POST /api/v1/environments2/getTrustSetupCommands Lists the commands to be executed for cross-realm trust setup. #
POST /api/v1/environments2/getTrustCleanupCommands Gets the commands to be run for cross-realm trust clean up. #

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-environments-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/overlays/cloudera-environments-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-environments-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-environments-openapi.yml Raw ↑ 
swagger: '2.0'
x-endpoint-name: environments2
x-display-name: environments
x-products: CDP
x-form-factors: public,private
x-cdp-releases: PUBLIC
x-audit: true
info:
  version: 0.9.163
  title: Cloudera Environments Service
  license:
    name: Apache 2.0
  description: Cloudera Environments Service is a web service that manages cloud provider access.
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /api/v1/environments2/getCredentialPrerequisites:
    post:
      summary: This API provides the credential prerequisites for the given cloud provider.
      description: Provides the the credential prerequisites for the given cloud provider.
      operationId: getCredentialPrerequisites
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetCredentialPrerequisitesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetCredentialPrerequisitesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/getGovCloudCredentialPrerequisites:
    post:
      summary: This API provides the credential prerequisites for GovCloud for the enabled providers.
      description: Provides the the credential prerequisites for GovCloud for the enabled providers.
      operationId: getGovCloudCredentialPrerequisites
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetGovCloudCredentialPrerequisitesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetGovCloudCredentialPrerequisitesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/createAWSEnvironment:
    post:
      summary: Creates a new AWS environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
      description: Creates a new AWS environment.
      operationId: createAWSEnvironment
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateAWSEnvironmentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateAWSEnvironmentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/createAWSGovCloudEnvironment:
    post:
      summary: Creates a new AWS GovCloud environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
      description: Creates a new AWS GovCloud environment.
      operationId: createAWSGovCloudEnvironment
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateAWSGovCloudEnvironmentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateAWSGovCloudEnvironmentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/createAzureEnvironment:
    post:
      summary: Creates a new Azure environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
      description: Creates a new Azure environment.
      operationId: createAzureEnvironment
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateAzureEnvironmentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateAzureEnvironmentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/createGCPEnvironment:
    post:
      summary: Creates a new GCP environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
      description: Creates a new GCP environment.
      operationId: createGCPEnvironment
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateGCPEnvironmentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateGCPEnvironmentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/createPrivateEnvironment:
    post:
      summary: Creates a new Private Cloud environment by providing the Cloudera Manager address and credentials.
      description: Creates a new Private Cloud environment.
      operationId: createPrivateEnvironment
      x-form-factors: private
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreatePrivateEnvironmentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreatePrivateEnvironmentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/createAWSCredential:
    post:
      summary: Creates a new AWS credential that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
      description: Creates a new AWS credential.
      operationId: createAWSCredential
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateAWSCredentialRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateAWSCredentialResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/createAWSGovCloudCredential:
    post:
      summary: Creates a new AWS credential for GovCloud that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
      description: Creates a new AWS credential for GovCloud.
      operationId: createAWSGovCloudCredential
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateAWSGovCloudCredentialRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateAWSGovCloudCredentialResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/createAzureCredential:
    post:
      summary: Creates a new Azure credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
      description: Creates a new Azure credential.
      operationId: createAzureCredential
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateAzureCredentialRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateAzureCredentialResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/updateAzureCredential:
    post:
      summary: Updates a new certificate based Azure credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
      description: Updates a certificate based Azure credential.
      operationId: updateAzureCredential
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateAzureCredentialRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateAzureCredentialResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/updateAwsCredential:
    post:
      summary: Updates an AWS credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
      description: Updates an AWS credential.
      operationId: updateAwsCredential
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateAwsCredentialRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateAwsCredentialResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/createGCPCredential:
    post:
      summary: Creates a new GCP credential that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
      description: Creates a new GCP credential.
      operationId: createGCPCredential
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateGCPCredentialRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateGCPCredentialResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/changeEnvironmentCredential:
    post:
      summary: Changes the credential for an environment.
      description: Changes the credential for an environment.
      operationId: changeEnvironmentCredential
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ChangeEnvironmentCredentialRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ChangeEnvironmentCredentialResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/updateAzureEncryptionResources:
    post:
      summary: Update the Azure encryption resources for the environment.
      description: Updates the Azure encryption resources for the environment. Enables the SSE with CMK for newly created Azure resources for the existing environment.
      operationId: updateAzureEncryptionResources
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateAzureEncryptionResourcesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateAzureEncryptionResourcesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/updateAzureDatabaseResources:
    post:
      summary: Update the Azure database resources for the environment.
      description: Updates the Azure database resources for the environment. Enables deploying private Flexible Server for the existing environment.
      operationId: updateAzureDatabaseResources
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateAzureDatabaseResourcesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateAzureDatabaseResourcesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/updateAzureAvailabilityZones:
    post:
      summary: Update the Availability Zones for the Azure environment.
      description: Updates the Availability Zones for the Azure environment.
      operationId: updateAzureAvailabilityZones
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateAzureAvailabilityZonesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateAzureAvailabilityZonesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/updateAwsDiskEncryptionParameters:
    post:
      summary: Update the AWS encryption key ARN for the environment.
      description: Updates the AWS encryption key ARN for the environment. Enables the server side encryption with CMK for newly created AWS resources for the existing environment.
      operationId: updateAwsDiskEncryptionParameters
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateAwsDiskEncryptionParametersRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateAwsDiskEncryptionParametersResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/deleteEnvironment:
    post:
      summary: Deletes an environment.
      description: Deletes an environment.
      operationId: deleteEnvironment
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteEnvironmentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteEnvironmentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/deleteCredential:
    post:
      summary: Deletes a credential.
      description: Deletes a credential.
      operationId: deleteCredential
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteCredentialRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteCredentialResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/listEnvironments:
    post:
      summary: Lists environments.
      description: Lists environments.
      operationId: listEnvironments
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListEnvironmentsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListEnvironmentsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/listCredentials:
    post:
      summary: Lists credentials.
      description: Lists credentials.
      operationId: listCredentials
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListCredentialsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListCredentialsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/describeEnvironment:
    post:
      summary: Describes an environment.
      description: Describes an environment.
      operationId: describeEnvironment
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeEnvironmentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeEnvironmentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/syncAllUsers:
    post:
      summary: Synchronizes environments with all users and groups state with CDP.
      description: Synchronizes environments with all users and groups state with CDP.
      operationId: syncAllUsers
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/SyncAllUsersRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/SyncAllUsersResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/syncUser:
    post:
      summary: Synchronizes environments with single user to the FreeIPA servers.
      description: Synchronizes environments with single user to the FreeIPA servers.
      operationId: syncUser
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/SyncUserRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/SyncUserResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/syncStatus:
    post:
      summary: Returns status of the sync operation for the operation id.
      description: Returns status of the sync operation for the operation id. Operation Id should be one of the previously request sync operation.
      operationId: syncStatus
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/SyncStatusRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/SyncStatusResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/lastSyncStatus:
    post:
      summary: Returns status of the sync operation for the environment crn.
      description: Returns status of the sync operation for the environment based on crn.
      operationId: lastSyncStatus
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/LastSyncStatusRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/LastSyncStatusResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/listConnectedDataServices:
    post:
      summary: Returns the list of Data Services and their cluster names that are attached the given environment.
      description: Returns the list of Data Services and their cluster names that are attached to the given environment.
      operationId: listConnectedDataServices
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListConnectedDataServicesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListConnectedDataServicesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/getEnvironmentUserSyncState:
    post:
      summary: Returns the user synchronization state for an environment.
      description: Returns the user synchronization state for an environment.
      operationId: getEnvironmentUserSyncState
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetEnvironmentUserSyncStateRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetEnvironmentUserSyncStateResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/setPassword:
    post:
      summary: Sets workload user's password and updates into all environments.
      description: Deprecated. Use 'iam set-workload-password' command instead.
      operationId: setPassword
      x-deprecated: true
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/SetPasswordRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/SetPasswordResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/getRootCertificate:
    post:
      summary: This API provides contents of public certificate for an environment.
      description: This API provides the contents of the root public certificate for an environment. The contents are a base64 encoded blob between -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. This certificate can be imported by end users to establish trust with environment resources.
      operationId: getRootCertificate
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetRootCertificateRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetRootCertificateResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/getKeytab:
    post:
      summary: Retrieves a keytab for a user or machine user.
      description: Retrieves a keytab for a user or machine user.
      operationId: getKeytab
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetKeytabRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetKeytabResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/getAutomatedSyncEnvironmentStatus:
    post:
      summary: Gets the the automated sync status for the environment.
      description: Gets the the automated sync status for the environment.
      operationId: getAutomatedSyncEnvironmentStatus
      x-entitlement: WORKLOAD_IAM_SYNC
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetAutomatedSyncEnvironmentStatusRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetAutomatedSyncEnvironmentStatusResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/getIdBrokerMappings:
    post:
      summary: Gets all ID Broker mappings for an environment.
      description: Gets all ID Broker mappings for an environment.
      operationId: getIdBrokerMappings
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetIdBrokerMappingsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetIdBrokerMappingsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/setIdBrokerMappings:
    post:
      summary: Sets all ID Broker mappings for an environment.
      description: Sets all ID Broker mappings for an environment. Overwrites all existing mappings.
      operationId: setIdBrokerMappings
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/SetIdBrokerMappingsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/SetIdBrokerMappingsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/syncIdBrokerMappings:
    post:
      summary: Syncs all ID Broker mappings for an environment.
      description: Syncs all ID Broker mappings to all datalake clusters in an environment.
      operationId: syncIdBrokerMappings
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/SyncIdBrokerMappingsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/SyncIdBrokerMappingsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/getIdBrokerMappingsSyncStatus:
    post:
      summary: Gets ID Broker mappings sync status.
      description: Gets the status of the most recent ID Broker mappings sync operation, if any.
      operationId: getIdBrokerMappingsSyncStatus
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetIdBrokerMappingsSyncStatusRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetIdBrokerMappingsSyncStatusResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/startEnvironment:
    post:
      summary: Start an environment.
      description: Start an environment.
      operationId: startEnvironment
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/StartEnvironmentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/StartEnvironmentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/stopEnvironment:
    post:
      summary: Stop an environment.
      description: Stop an environment.
      operationId: stopEnvironment
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/StopEnvironmentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/StopEnvironmentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/getOperation:
    post:
      summary: Get the latest (in progress or finished) operation for the environment resource.
      description: Get the latest (in progress or finished) operation for the environment resource.
      operationId: getOperation
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetOperationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetOperationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/checkEnvironmentConnectivity:
    post:
      summary: Checks connectivity to a new Private Cloud environment by trying to access the Cloudera Manager address with provided credentials.
      description: Checks connectivity to a Private Cloud environment.
      operationId: checkEnvironmentConnectivity
      x-form-factors: private
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CheckEnvironmentConnectivityRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CheckEnvironmentConnectivityResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/environments2/checkDatabaseConnectivity:
    post:
      summary: Checks Database connectivity based on the input parameters.
      description: Checks Database connectivity based on the input parameters.
      operationId: checkDatabaseConnectivity

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