# Cloudera Environments2 API

**Canonical:** https://apis.io/apis/cloudera/cloudera-environments2-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 Environments2 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 Environments2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Environments2 API from Cloudera — 104 operation(s) for environments2.

## Operations (60 of 104)

| Method | Path | Summary |
|---|---|---|
| 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… |
| POST | `/api/v1/environments2/createAWSEnvironment` | Creates a new AWS environment by providing the cloud provider access and… |
| POST | `/api/v1/environments2/createAWSGovCloudEnvironment` | Creates a new AWS GovCloud environment by providing the cloud provider access… |
| POST | `/api/v1/environments2/createAzureEnvironment` | Creates a new Azure environment by providing the cloud provider access and… |
| POST | `/api/v1/environments2/createGCPEnvironment` | Creates a new GCP environment by providing the cloud provider access and… |
| POST | `/api/v1/environments2/createPrivateEnvironment` | Creates a new Private Cloud environment by providing the Cloudera Manager… |
| POST | `/api/v1/environments2/createAWSCredential` | Creates a new AWS credential that can be attatched to an environment. |
| POST | `/api/v1/environments2/createAWSGovCloudCredential` | Creates a new AWS credential for GovCloud that can be attatched to an… |
| POST | `/api/v1/environments2/createAzureCredential` | Creates a new Azure credential that can be attached to an environment. |
| POST | `/api/v1/environments2/updateAzureCredential` | Updates a new certificate based Azure credential that can be attached to an… |
| POST | `/api/v1/environments2/updateAwsCredential` | Updates an AWS credential that can be attached to an environment. |
| POST | `/api/v1/environments2/createGCPCredential` | Creates a new GCP credential that can be attatched to an environment. |
| 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… |
| 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… |
| 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. |
| POST | `/api/v1/environments2/getAccountTelemetry` | Get account level telemetry settings. |
| POST | `/api/v1/environments2/getAccountTelemetryDefault` | Get default account level telemetry settings. |
| 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 |

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

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-environments2-api-openapi.yml
- **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 Manager API](https://apis.io/apis/cloudera/manager/)
- [Cloudera Cruise Control REST API](https://apis.io/apis/cloudera/cruise-control/)
- [Streams Replication Manager Service REST API](https://apis.io/apis/cloudera/srm/)
- [HBase REST Server](https://apis.io/apis/cloudera/hbase-rest/)
- [YARN Queue Manager API](https://apis.io/apis/cloudera/yarn-queue-manager/)
- [Cloudera Audit API](https://apis.io/apis/cloudera/cloudera-audit-api/)
- [Cloudera CDF Local RPCAPI Version1 API](https://apis.io/apis/cloudera/cloudera-cdflocalrpcapiversion1-api/)
- [Cloudera Cloudprivatelinks API](https://apis.io/apis/cloudera/cloudera-cloudprivatelinks-api/)
- [Cloudera Compute API](https://apis.io/apis/cloudera/cloudera-compute-api/)
- [Cloudera Consumption API](https://apis.io/apis/cloudera/cloudera-consumption-api/)
- [Cloudera Datalake API](https://apis.io/apis/cloudera/cloudera-datalake-api/)
- [Cloudera De API](https://apis.io/apis/cloudera/cloudera-de-api/)

## Tags

Environments2

---

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