Cloudera

Cloudera Environments2 API

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

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 104

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/v1/environments2/getCredentialPrerequisites Get credential prerequisites for a cloud provider · This API provides the credential prerequisites for the given cloud provider #
Ask an LLM
“What do I need to set up in my cloud account before creating a CDP credential?”
“Which policies does a commercial-cloud credential require for my provider?”
Tell an agent
Get the credential prerequisites for {cloudPlatform}.
Show the role and policy prerequisites for a {cloudPlatform} credential.
POST /api/v1/environments2/getGovCloudCredentialPrerequisites Get GovCloud credential prerequisites · This API provides the credential prerequisites for GovCloud for the enabled… #
Ask an LLM
“What prerequisites apply to a GovCloud credential in CDP?”
“Which policies must exist before I create a credential for GovCloud?”
Tell an agent
Get GovCloud credential prerequisites for {cloudPlatform}.
Show what a GovCloud credential on {cloudPlatform} needs set up first.
POST /api/v1/environments2/createAWSEnvironment Create an AWS environment · Creates a new AWS environment by providing the cloud provider access and… #
Ask an LLM
“How do I create a new CDP environment in AWS commercial regions?”
“Can CDP create private subnets for me when I set up an AWS environment?”
Tell an agent
Create AWS environment {environmentName} in {region} using credential {credentialName}.
Set up AWS environment {environmentName} with credential {credentialName} in {region}, inside VPC {vpcId}.
POST /api/v1/environments2/createAWSGovCloudEnvironment Create an AWS GovCloud environment · Creates a new AWS GovCloud environment by providing the cloud provider access… #
Ask an LLM
“How do I create a CDP environment in AWS GovCloud?”
“Can I give a network CIDR when creating a GovCloud environment?”
Tell an agent
Create AWS GovCloud environment {environmentName} in {region} with credential {credentialName}.
Set up GovCloud environment {environmentName} in {region} using {credentialName} and network CIDR {networkCidr}.
POST /api/v1/environments2/createAzureEnvironment Create an Azure environment · Creates a new Azure environment by providing the cloud provider access and… #
Ask an LLM
“What's needed to create a CDP environment on Azure?”
“Can my Azure environment use an existing resource group and availability zones?”
Tell an agent
Create Azure environment {environmentName} in {region} with credential {credentialName}.
Set up Azure environment {environmentName} in {region} using {credentialName} in resource group {resourceGroupName}.
POST /api/v1/environments2/createGCPEnvironment Create a GCP environment · Creates a new GCP environment by providing the cloud provider access and… #
Ask an LLM
“How do I create a CDP environment on Google Cloud?”
“Can a GCP environment use a customer encryption key?”
Tell an agent
Create GCP environment {environmentName} in {region} with credential {credentialName}.
Set up Google Cloud environment {environmentName} in {region} using {credentialName} and encryption key {encryptionKey}.
POST /api/v1/environments2/createPrivateEnvironment Create a Private Cloud environment · Creates a new Private Cloud environment by providing the Cloudera Manager… #
Ask an LLM
“How do I register an on-prem Private Cloud environment from Cloudera Manager?”
“Which Cloudera Manager clusters can I attach when creating a Private Cloud environment?”
Tell an agent
Create Private Cloud environment {environmentName} from Cloudera Manager at {address} as {user} with clusters {clusterNames}.
Register private environment {environmentName} using Cloudera Manager {address}, user {user}, token {authenticationToken}, clusters {clusterNames}.
POST /api/v1/environments2/createAWSCredential Create an AWS credential · Creates a new AWS credential that can be attatched to an environment. #
Ask an LLM
“How do I give CDP access to my AWS account with a cross-account role?”
“What IAM role ARN does a new AWS credential need?”
Tell an agent
Create AWS credential {credentialName} with role ARN {roleArn}.
Add a new commercial AWS credential named {credentialName} for role {roleArn}.
POST /api/v1/environments2/createAWSGovCloudCredential Create an AWS GovCloud credential · Creates a new AWS credential for GovCloud that can be attatched to an… #
Ask an LLM
“How do I create a credential for AWS GovCloud in CDP?”
“Does a GovCloud credential also use a cross-account role ARN?”
Tell an agent
Create GovCloud credential {credentialName} with role ARN {roleArn}.
Add an AWS GovCloud credential named {credentialName} using role {roleArn}.
POST /api/v1/environments2/createAzureCredential Create an Azure credential · Creates a new Azure credential that can be attached to an environment. #
Ask an LLM
“What do I need to create an Azure credential for CDP?”
“Can I make an app-based Azure credential tied to a specific subscription and tenant?”
Tell an agent
Create Azure credential {credentialName} for subscription {subscriptionId} and tenant {tenantId}.
Add a new app-based Azure credential named {credentialName} with app details {appBased}.
POST /api/v1/environments2/updateAzureCredential Update a certificate-based Azure credential · Updates a new certificate based Azure credential that can be attached to an… #
Ask an LLM
“Can I change the subscription or tenant on an existing certificate-based Azure credential?”
“How do I refresh the app details on an Azure credential I already have?”
Tell an agent
Update existing Azure credential {credentialName} to subscription {subscriptionId}, tenant {tenantId}, app {appBased}.
Modify the certificate-based Azure credential {credentialName} for tenant {tenantId}, subscription {subscriptionId}, app {appBased}.
POST /api/v1/environments2/updateAwsCredential Update an existing AWS credential · Updates an AWS credential that can be attached to an environment. #
Ask an LLM
“How do I point an existing AWS credential at a new role ARN?”
“Can permissions be verified when I update an AWS credential?”
Tell an agent
Update existing AWS credential {credentialName} to use role {roleArn}.
Swap the role on AWS credential {credentialName} to {roleArn} and verify its permissions.
POST /api/v1/environments2/createGCPCredential Create a GCP credential · Creates a new GCP credential that can be attatched to an environment. #
Ask an LLM
“How do I give CDP access to my Google Cloud project?”
“What service account key does a GCP credential need?”
Tell an agent
Create GCP credential {credentialName} with service account key {credentialKey}.
Add a Google Cloud credential named {credentialName} using key {credentialKey}.
POST /api/v1/environments2/changeEnvironmentCredential Switch the credential an environment uses · Changes the credential for an environment #
Ask an LLM
“Can I swap which credential an existing environment uses?”
“How do I move an environment onto a different cloud credential?”
Tell an agent
Change environment {environmentName} to use credential {credentialName}.
Switch {environmentName} over to credential {credentialName}.
POST /api/v1/environments2/updateAzureEncryptionResources Enable customer-managed keys on an Azure environment · Update the Azure encryption resources for the environment #
Ask an LLM
“How do I turn on server-side encryption with my own key for an existing Azure environment?”
“Can I add a user-managed identity for Azure disk encryption later?”
Tell an agent
Set Azure encryption key {encryptionKeyUrl} on environment {environment}.
Enable CMK encryption for Azure environment {environment} with key {encryptionKeyUrl} in resource group {encryptionKeyResourceGroupName}.
POST /api/v1/environments2/updateAzureDatabaseResources Enable private Flexible Server on an Azure environment · Update the Azure database resources for the environment #
Ask an LLM
“How do I deploy a private Azure Flexible Server database for an existing environment?”
“Can I set the private DNS zone used for the environment's database?”
Tell an agent
Update Azure environment {environment} to use Flexible Server subnets {flexibleServerSubnetIds}.
Set database private DNS zone {databasePrivateDnsZoneId} on Azure environment {environment}.
POST /api/v1/environments2/updateAzureAvailabilityZones Change availability zones for an Azure environment · Update the Availability Zones for the Azure environment #
Ask an LLM
“Can I change which availability zones my Azure environment spreads across?”
“How do I add zones to an existing Azure environment?”
Tell an agent
Set availability zones {availabilityZones} on Azure environment {environment}.
Update the Azure zones for {environment} to {availabilityZones}.
POST /api/v1/environments2/updateAwsDiskEncryptionParameters Set the AWS encryption key for an environment · Update the AWS encryption key ARN for the environment #
Ask an LLM
“How do I enable KMS customer-managed key encryption on an existing AWS environment?”
“Will a new encryption key ARN apply to resources already created?”
Tell an agent
Set encryption key ARN {encryptionKeyArn} on AWS environment {environment}.
Turn on CMK disk encryption for {environment} with key {encryptionKeyArn}.
POST /api/v1/environments2/deleteEnvironment Delete an environment · Deletes an environment #
Ask an LLM
“How do I delete a CDP environment I no longer need?”
“Can deleting an environment also cascade to its attached clusters?”
Tell an agent destructive · confirm first
Delete environment {environmentName}.
Delete environment {environmentName} and everything attached to it.
POST /api/v1/environments2/deleteCredential Delete a credential · Deletes a credential #
Ask an LLM
“How do I remove an environment credential I no longer use?”
“Is deleting a credential permanent?”
Tell an agent destructive · confirm first
Delete credential {credentialName}.
Remove the environment credential called {credentialName}.
POST /api/v1/environments2/listEnvironments List environments · Lists environments #
Ask an LLM
“Which CDP environments exist in my account?”
“What environments do I have across all clouds?”
Tell an agent
List all my environments.
Show every environment in the account.
POST /api/v1/environments2/listCredentials List environment credentials · Lists credentials #
Ask an LLM
“Which cloud credentials are registered for my environments?”
“Can I look up one credential by name?”
Tell an agent
List my environment credentials.
Find the credential named {credentialName}.
POST /api/v1/environments2/describeEnvironment Describe an environment · Describes an environment #
Ask an LLM
“What's the status and configuration of a specific environment?”
“Can I see the network and region details of one environment?”
Tell an agent
Describe environment {environmentName}.
Show me the full details of {environmentName}.
POST /api/v1/environments2/syncAllUsers Sync all users and groups to environments · Synchronizes environments with all users and groups state with CDP #
Ask an LLM
“How do I push all user and group changes out to my environments?”
“Can I limit a full user sync to certain environments?”
Tell an agent
Sync all users and groups to every environment.
Run a full user and group sync on environments {environmentNames}.
POST /api/v1/environments2/syncUser Sync the current user to FreeIPA · Synchronizes environments with single user to the FreeIPA servers #
Ask an LLM
“Can I sync just my own user to the FreeIPA servers without a full sync?”
“Is there a single-user sync for environments?”
Tell an agent
Sync my user to the FreeIPA servers in all environments.
Push only my user account out to FreeIPA.
POST /api/v1/environments2/syncStatus Check status of a user sync operation · Returns status of the sync operation for the operation id #
Ask an LLM
“Did the user sync I started finish successfully?”
“How do I check a sync operation by its operation ID?”
Tell an agent
Get the status of user sync operation {operationId}.
Check whether sync {operationId} has completed.
POST /api/v1/environments2/lastSyncStatus Get the last user sync status for an environment · Returns status of the sync operation for the environment crn #
Ask an LLM
“When did user sync last run for this environment, and did it work?”
“Can I see the most recent sync result by environment CRN?”
Tell an agent
Show the last user sync status for environment {envNameOrCrn}.
Get the most recent sync outcome for {environment}.
POST /api/v1/environments2/listConnectedDataServices List data services attached to an environment · Returns the list of Data Services and their cluster names that are attached the… #
Ask an LLM
“Which data services and clusters are running in my environment?”
“What would be affected if I deleted this environment?”
Tell an agent
List the data services attached to {environment}.
Show connected data service clusters in environment {environment}.
POST /api/v1/environments2/getEnvironmentUserSyncState Get an environment's user sync state · Returns the user synchronization state for an environment #
Ask an LLM
“Is user synchronization in a healthy state for my environment?”
“Does this environment need a user sync?”
Tell an agent
Get the user sync state of {environmentName}.
Check if {environmentName} is in sync with users and groups.
POST /api/v1/environments2/setPassword Set a workload password (deprecated) · Sets workload user's password and updates into all environments #
Ask an LLM
“Is there an older environments call for setting my workload password?”
“Can I set my workload password for only certain environments?”
Tell an agent
Set my workload password to {password} using the deprecated environments call.
Update my workload password to {password} in environments {environmentCRNs}.
POST /api/v1/environments2/getRootCertificate Get an environment's root certificate · This API provides contents of public certificate for an environment #
Ask an LLM
“Where can I download the root CA certificate for my environment?”
“Which certificate do clients need to trust to connect over TLS?”
Tell an agent
Get the root certificate for {environmentName}.
Download the public root CA cert of environment {environmentName}.
POST /api/v1/environments2/getKeytab Retrieve a Kerberos keytab · Retrieves a keytab for a user or machine user #
Ask an LLM
“How do I get a keytab for my user in an environment?”
“Can I retrieve a keytab for a machine user?”
Tell an agent
Get my keytab for environment {environmentName}.
Retrieve the keytab for {actorCrn} in {environmentName}.
POST /api/v1/environments2/getAutomatedSyncEnvironmentStatus Get automated user sync status · Gets the the automated sync status for the environment #
Ask an LLM
“Is automated user sync turned on and working for my environment?”
“What does the automatic sync report for this environment?”
Tell an agent
Get the automated sync status for {environmentName}.
Check automatic user sync on environment {environmentName}.
POST /api/v1/environments2/getIdBrokerMappings Get ID Broker mappings for an environment · Gets all ID Broker mappings for an environment #
Ask an LLM
“Which cloud roles are users and groups mapped to through ID Broker?”
“What data access role does my environment's ID Broker use?”
Tell an agent
Show the ID Broker mappings for {environmentName}.
Get all user and group role mappings in ID Broker for {environmentName}.
POST /api/v1/environments2/setIdBrokerMappings Set ID Broker mappings for an environment · Sets all ID Broker mappings for an environment #
Ask an LLM
“How do I map users and groups to cloud roles in ID Broker?”
“Will setting ID Broker mappings overwrite the ones already there?”
Tell an agent
Set ID Broker mappings on {environmentName} with data access role {dataAccessRole}.
Replace the ID Broker mappings for {environmentName} with {mappings}, using data access role {dataAccessRole}.
POST /api/v1/environments2/syncIdBrokerMappings Push ID Broker mappings to data lakes · Syncs all ID Broker mappings for an environment #
Ask an LLM
“How do I apply my ID Broker mapping changes to the data lake clusters?”
“Do ID Broker mappings need syncing after I change them?”
Tell an agent
Sync ID Broker mappings to the data lakes in {environmentName}.
Push the current ID Broker mappings out for environment {environmentName}.
POST /api/v1/environments2/getIdBrokerMappingsSyncStatus Check ID Broker mappings sync status · Gets ID Broker mappings sync status #
Ask an LLM
“Did my last ID Broker mappings sync succeed?”
“Are the ID Broker mappings still syncing to the data lake?”
Tell an agent
Get the ID Broker mappings sync status for {environmentName}.
Check the most recent ID Broker sync result in {environmentName}.
POST /api/v1/environments2/startEnvironment Start an environment · Start an environment #
Ask an LLM
“How do I start a stopped environment?”
“Can I start the Data Hub clusters along with the environment?”
Tell an agent
Start environment {environmentName}.
Start {environmentName} and its Data Hub clusters too.
POST /api/v1/environments2/stopEnvironment Stop an environment · Stop an environment #
Ask an LLM
“Can I stop an environment to save cloud costs?”
“What's the way to pause a whole CDP environment?”
Tell an agent
Stop environment {environmentName}.
Pause {environmentName} until I need it again.
POST /api/v1/environments2/getOperation Get the latest operation on an environment · Get the latest (in progress or finished) operation for the environment resource #
Ask an LLM
“What operation is currently running on my environment?”
“Did the last environment operation finish or fail?”
Tell an agent
Get the latest operation for environment {environmentName}.
Show progress of operation {operationId} on {environmentName}.
POST /api/v1/environments2/checkEnvironmentConnectivity Test connectivity to Cloudera Manager · Checks connectivity to a new Private Cloud environment by trying to access the… #
Ask an LLM
“Can CDP reach my Cloudera Manager before I create a Private Cloud environment?”
“How do I test Cloudera Manager credentials ahead of registering an environment?”
Tell an agent
Check connectivity to Cloudera Manager at {address} as {user} with token {authenticationToken}.
Test whether Cloudera Manager {address} accepts login {user} using token {authenticationToken}.
POST /api/v1/environments2/checkDatabaseConnectivity Test database connectivity · Checks Database connectivity based on the input parameters #
Ask an LLM
“Can I verify a database is reachable with given host, port and credentials?”
“Is there a way to test a database login before using it?”
Tell an agent
Check connectivity to database {name} at {host}:{port} as {username} with password {password}.
Test login to {name} on host {host} port {port} using {username} / {password}.
POST /api/v1/environments2/checkKubernetesConnectivity Test Kubernetes connectivity with a kubeconfig · Checks connectivity to a Kubernetes address with provided kubeconfig files #
Ask an LLM
“Will my kubeconfig let CDP reach the Kubernetes cluster?”
“How can I validate a Kubernetes connection before setting up Private Cloud?”
Tell an agent
Check Kubernetes connectivity using kubeconfig {kubeConfig}.
Test that kubeconfig {kubeConfig} in {format} format reaches the cluster.
POST /api/v1/environments2/getFreeipaStatus Get FreeIPA service health · Get the status of the FreeIPA services #
Ask an LLM
“Are the FreeIPA nodes in my environment healthy?”
“Which FreeIPA services are down right now?”
Tell an agent
Get the FreeIPA status for {environmentName}.
Check FreeIPA node services and connectivity in {environmentName}.
POST /api/v1/environments2/attachFreeIpaRecipes Attach recipes to FreeIPA · Attach recipes to FreeIPA #
Ask an LLM
“How do I run custom scripts on my FreeIPA nodes?”
“Can I add recipes to FreeIPA after the environment exists?”
Tell an agent
Attach recipes {recipes} to FreeIPA in {environment}.
Add FreeIPA recipes {recipes} to environment {environment}.
POST /api/v1/environments2/detachFreeIpaRecipes Detach recipes from FreeIPA · Detach recipes from FreeIPA #
Ask an LLM
“How do I stop a recipe from running on FreeIPA?”
“Can I detach several FreeIPA recipes at once?”
Tell an agent
Detach recipes {recipes} from FreeIPA in {environment}.
Remove FreeIPA recipes {recipes} from environment {environment}.
POST /api/v1/environments2/repairFreeipa Repair broken FreeIPA nodes · Repairs the FreeIPA nodes #
Ask an LLM
“My FreeIPA nodes are not working; how do I repair them?”
“Can I repair only specific FreeIPA instances?”
Tell an agent
Repair FreeIPA in {environmentName}.
Repair FreeIPA instances {instances} in {environmentName}.
POST /api/v1/environments2/getRepairFreeipaStatus Check a FreeIPA repair's status · Returns status of the repair operation for the operation id #
Ask an LLM
“Is my FreeIPA repair still running?”
“Did the FreeIPA repair operation succeed?”
Tell an agent
Get the status of FreeIPA repair {operationId}.
Check FreeIPA repair operation {operationId}.
POST /api/v1/environments2/createProxyConfig Create a proxy configuration · Creates a new proxy config that can be attatched to an environment #
Ask an LLM
“How do I route environment traffic through an outbound proxy?”
“Can a proxy config include hosts that bypass the proxy?”
Tell an agent
Create proxy config {proxyConfigName} for {protocol}://{host}:{port}.
Add proxy {proxyConfigName} at {host} port {port} over {protocol}, skipping {noProxyHosts}.
POST /api/v1/environments2/listProxyConfigs List proxy configurations · Lists proxy configs #
Ask an LLM
“Which proxy configs are defined in my account?”
“Can I look up a proxy config by name?”
Tell an agent
List my proxy configs.
Find the proxy config named {proxyConfigName}.
POST /api/v1/environments2/deleteProxyConfig Delete a proxy configuration · Deletes a proxy config #
Ask an LLM
“How do I delete a proxy config I no longer need?”
“Is removing a proxy config reversible?”
Tell an agent destructive · confirm first
Delete proxy config {proxyConfigName}.
Remove the proxy configuration called {proxyConfigName}.
POST /api/v1/environments2/setTelemetryFeatures Configure telemetry for an environment · Configure environment level telemetry feature setting #
Ask an LLM
“Can I turn workload analytics on or off for one environment?”
“Where is environment-level telemetry configured?”
Tell an agent
Set telemetry features on environment {environmentName}.
Set workload analytics to {workloadAnalytics} for environment {environmentName}.
POST /api/v1/environments2/getEnvironmentSetting Read an environment configuration setting · Read a configuration setting from the environment service #
Ask an LLM
“What value is a configuration setting set to in the environment service?”
“Can I read specific settings attributes for one environment?”
Tell an agent
Read environment settings {attrs}.
Get the setting values {attrs} for environment {environmentName}.
POST /api/v1/environments2/setEnvironmentSetting Change an environment configuration setting · Read a configuration setting from the environment service #
Ask an LLM
“Can I change configuration settings in the environment service?”
“Is it possible to apply a setting to just one environment?”
Tell an agent
Apply environment settings {settings}.
Write settings {settings} to environment {environmentName}.
POST /api/v1/environments2/setAccountTelemetry Set account-wide telemetry and anonymization · Set account level telemetry settings. #
Ask an LLM
“How do I configure telemetry for the whole account rather than one environment?”
“Can I add anonymization rules to account telemetry?”
Tell an agent
Set account telemetry anonymization rules to {rules}.
Set account-level workload analytics to {workloadAnalytics}.
POST /api/v1/environments2/getAccountTelemetry Get account telemetry settings · Get account level telemetry settings. #
Ask an LLM
“What telemetry features and anonymization rules are set on my account?”
“Is workload analytics enabled account-wide right now?”
Tell an agent
Show my account's current telemetry settings.
Get the account anonymization rules in effect.
POST /api/v1/environments2/getAccountTelemetryDefault Get default account telemetry settings · Get default account level telemetry settings. #
Ask an LLM
“What are the default account telemetry values if I want to reset them?”
“Which anonymization rules ship by default?”
Tell an agent
Get the default account telemetry settings.
Show the factory default telemetry configuration so I can restore it.
POST /api/v1/environments2/testAccountTelemetryRules Test anonymization rules against sample text · Test anonymization rules (for account telemetry) against text input #
Ask an LLM
“Will my telemetry anonymization rules actually mask this text?”
“Can I dry-run anonymization rules before saving them?”
Tell an agent
Test anonymization rules {rules} against {testInput}.
Show what {testInput} looks like after applying rules {rules}.
POST /api/v1/environments2/getFreeipaLogDescriptors List FreeIPA log descriptors for diagnostics · Gather log descriptors that are used for diagnostics collection #
Ask an LLM
“Which logs can be included in a FreeIPA diagnostics collection?”
“What log descriptors does FreeIPA diagnostics use?”
Tell an agent
List the FreeIPA log descriptors.
Show which logs FreeIPA diagnostics can gather.
POST /api/v1/environments2/collectFreeipaDiagnostics Start a FreeIPA diagnostics collection · Start FreeIPA diagnostics collection #
Ask an LLM
“How do I gather FreeIPA logs for a support case?”
“Can FreeIPA diagnostics be limited to a date range or specific hosts?”
Tell an agent
Collect FreeIPA diagnostics in {environmentName} to {destination} described as {description}.
Start FreeIPA log collection for {environmentName} to {destination}, note {description}, case {caseNumber}.
POST /api/v1/environments2/listFreeipaDiagnostics List recent FreeIPA diagnostics collections · List recent FreeIPA diagnostics collections #
Ask an LLM
“Which FreeIPA diagnostics collections have run recently?”
“Is a FreeIPA log collection still in progress?”
Tell an agent
List recent FreeIPA diagnostics in {environmentName}.
Show past FreeIPA log collections for {environmentName}.
POST /api/v1/environments2/cancelFreeipaDiagnostics Cancel a running FreeIPA diagnostics collection · Cancel running FreeIPA diagnostics collections #
Ask an LLM
“How do I stop a FreeIPA diagnostics collection that's taking too long?”
“Can a running FreeIPA log collection be cancelled?”
Tell an agent destructive · confirm first
Cancel FreeIPA diagnostics running in {environmentName}.
Abort the in-progress FreeIPA log collection on {environmentName}.
POST /api/v1/environments2/getAuditCredentialPrerequisites Get audit credential prerequisites · This API provides the audit credential prerequisites for the given cloud… #
Ask an LLM
“What does my cloud account need before I set an audit credential?”
“Which policies are required for a commercial-cloud audit credential?”
Tell an agent
Get audit credential prerequisites for {cloudPlatform}.
Show what an audit credential on {cloudPlatform} requires.
POST /api/v1/environments2/getGovCloudAuditCredentialPrerequisites Get GovCloud audit credential prerequisites · This API provides the audit credential prerequisites for GovCloud for the… #
Ask an LLM
“What prerequisites apply to an audit credential in GovCloud?”
“Which GovCloud policies does the audit credential need?”
Tell an agent
Get GovCloud audit credential prerequisites for {cloudPlatform}.
Show the GovCloud audit credential setup needed on {cloudPlatform}.
POST /api/v1/environments2/listAuditCredentials List audit credentials · Lists audit credentials #
Ask an LLM
“Which audit credentials are configured for my account?”
“Do I already have an audit credential set up?”
Tell an agent
List my audit credentials.
Show the account's audit credentials.
POST /api/v1/environments2/setAWSAuditCredential Create or update the AWS audit credential · Creates or updates the AWS audit credential for the account. #
Ask an LLM
“How do I set up the AWS audit credential for my account?”
“Can I change the role ARN of the existing AWS audit credential?”
Tell an agent
Set the AWS audit credential to role {roleArn}.
Create or update my commercial AWS audit credential with role ARN {roleArn}.
POST /api/v1/environments2/setAWSGovCloudAuditCredential Create or update the GovCloud audit credential · Creates or updates the AWS GovCloud audit credential for the account. #
Ask an LLM
“Can I configure an audit credential for AWS GovCloud?”
“What role does the GovCloud audit credential use?”
Tell an agent
Point the GovCloud audit credential for this account at IAM role {roleArn}.
Create or update my GovCloud audit credential with role ARN {roleArn}.
POST /api/v1/environments2/setAzureAuditCredential Create or update the Azure audit credential · Creates or updates the Azure audit credential for the account. #
Ask an LLM
“How do I set the Azure audit credential for my account?”
“Which subscription and tenant does the Azure audit credential use?”
Tell an agent
Set the Azure audit credential for subscription {subscriptionId}, tenant {tenantId}, app {appBased}.
Create or update the account's Azure audit credential with tenant {tenantId}, subscription {subscriptionId} and app {appBased}.
POST /api/v1/environments2/setGCPAuditCredential Create or update the GCP audit credential · Creates or updates the GCP audit credential for the account. #
Ask an LLM
“Can I set an audit credential for Google Cloud?”
“What key does the GCP audit credential need?”
Tell an agent
Set the GCP audit credential with key {credentialKey}.
Create or update my Google Cloud audit credential using {credentialKey}.
POST /api/v1/environments2/deleteAuditCredential Delete an audit credential · Deletes an audit credential #
Ask an LLM
“How do I remove an audit credential from my account?”
“Is deleting an audit credential permanent?”
Tell an agent destructive · confirm first
Delete audit credential {credentialName}.
Remove the audit credential named {credentialName}.
POST /api/v1/environments2/setEndpointAccessGateway Configure the endpoint access gateway · Sets endpoint access gateway settings for the environment #
Ask an LLM
“Can I make my environment's endpoint access gateway public or private?”
“Which subnets does the endpoint access gateway use?”
Tell an agent
Set the endpoint access gateway on {environment} to scheme {endpointAccessGatewayScheme}.
Configure {environment}'s endpoint gateway as {endpointAccessGatewayScheme} on subnets {endpointAccessGatewaySubnetIds}.
POST /api/v1/environments2/updateSshKey Change an environment's SSH key · Updates the designated SSH key for the given environment. #
Ask an LLM
“How do I rotate the SSH key used for new Data Hub clusters?”
“Will an updated SSH key apply to clusters that already exist?”
Tell an agent
Update the SSH key on {environment} to {newPublicKey}.
Switch {environment} to existing public key {existingPublicKeyId}.
POST /api/v1/environments2/updateSubnet Change an environment's subnets · Updates the subnet(s) of the given environment. #
Ask an LLM
“Can I add subnets to an existing environment for new Data Hub clusters?”
“Do updated subnets affect the clusters already running?”
Tell an agent
Update the subnets of {environment} to {subnetIds}.
Set endpoint gateway subnets {endpointAccessGatewaySubnetIds} on environment {environment}.
POST /api/v1/environments2/updateSecurityAccess Change an environment's security groups · Updates the security access settings of the given environment. #
Ask an LLM
“How do I swap the security groups used by an environment?”
“Which security groups apply to gateway nodes versus the default?”
Tell an agent
Update {environment} security groups: gateway {gatewayNodeSecurityGroupId}, default {defaultSecurityGroupId}.
Set gateway node group {gatewayNodeSecurityGroupId} and default group {defaultSecurityGroupId} on environment {environment}.
POST /api/v1/environments2/updateTags Update an environment's user-defined tags · Updates the user defined tags of the given environment. #
Ask an LLM
“Can I change the cloud resource tags on an existing environment?”
“Do new environment tags apply to clusters created before the change?”
Tell an agent
Update the tags on {environment} to {tags}.
Apply user-defined tags {tags} to environment {environment}.
POST /api/v1/environments2/validateAwsCloudStorage Validate AWS cloud storage settings · Validates AWS cloud storage settings of the given environment #
Ask an LLM
“Will my S3 storage location and instance profile work for this environment?”
“How can I check AWS storage permissions before deploying?”
Tell an agent
Validate AWS storage {storageLocation} with instance profile {instanceProfile} and credential {credentialCrn}.
Check S3 location {storageLocation} using credential {credentialCrn} and profile {instanceProfile}.
POST /api/v1/environments2/validateAzureCloudStorage Validate Azure cloud storage settings · Validates Azure cloud storage settings of the given environment #
Ask an LLM
“Is my Azure storage location configured correctly for the environment?”
“Can I validate Azure storage with a managed identity?”
Tell an agent
Validate Azure storage {storageLocation} with credential {credentialCrn}.
Check Azure location {storageLocation} using managed identity {managedIdentity} and credential {credentialCrn}.
POST /api/v1/environments2/setCatalog Set the image catalog for FreeIPA · Sets a catalog for a FreeIPA installation #
Ask an LLM
“Can I point FreeIPA at a custom image catalog?”
“Which image catalog does my FreeIPA installation use?”
Tell an agent
Set FreeIPA image catalog {catalog} on {environment}.
Use catalog {catalog} for the FreeIPA in environment {environment}.
POST /api/v1/environments2/upgradeFreeipa Upgrade FreeIPA to a newer image · Upgrades FreeIPA to the latest or defined image #
Ask an LLM
“How do I upgrade FreeIPA to the latest image?”
“Can a FreeIPA upgrade include a major OS upgrade?”
Tell an agent
Upgrade FreeIPA in {environmentName} to the latest image.
Upgrade FreeIPA on {environmentName} to image {imageId}.
POST /api/v1/environments2/getFreeipaUpgradeOptions List available FreeIPA upgrade images · Get available images for FreeIPA upgrade #
Ask an LLM
“Which images can my FreeIPA be upgraded to?”
“Are there FreeIPA upgrade options in a specific catalog?”
Tell an agent
Show FreeIPA upgrade options for {environment}.
List FreeIPA upgrade images for {environment} from catalog {catalog}.
POST /api/v1/environments2/upscaleFreeipa Scale FreeIPA up to higher availability · Upscales FreeIPA instances #
Ask an LLM
“How do I add FreeIPA instances for high availability?”
“What availability types can FreeIPA be upscaled to?”
Tell an agent
Upscale FreeIPA in {environmentName} to {targetAvailabilityType}.
Increase FreeIPA availability on {environmentName} to {targetAvailabilityType}.
POST /api/v1/environments2/downscaleFreeipa Scale FreeIPA down · Downscales FreeIPA instances #
Ask an LLM
“Can I reduce the number of FreeIPA instances to save cost?”
“Is it possible to remove specific FreeIPA instances when downscaling?”
Tell an agent
Downscale FreeIPA in {environmentName} to {targetAvailabilityType}.
Remove FreeIPA instances {instances} from {environmentName}.
POST /api/v1/environments2/retryFreeipa Retry the last failed FreeIPA operation · Retries the last failed operation on a FreeIPA #
Ask an LLM
“My last FreeIPA operation failed; can I retry it?”
“Is there a way to rerun a failed FreeIPA step without starting over?”
Tell an agent
Retry the last failed FreeIPA operation in {environment}.
Rerun the failed FreeIPA step on {environment}.
POST /api/v1/environments2/startFreeIpaVerticalScaling Vertically scale FreeIPA instances · Initiates the vertical scaling on FreeIPA #
Ask an LLM
“Can I move FreeIPA to bigger instance types?”
“How is FreeIPA vertical scaling started?”
Tell an agent
Vertically scale FreeIPA in {environment} to instance template {instanceTemplate}.
Resize the FreeIPA instances of {environment} using {instanceTemplate}.
POST /api/v1/environments2/upgradeCcm Upgrade Cluster Connectivity Manager · Upgrades Cluster Connectivity Manager on the environment to the latest… #
Ask an LLM
“How do I bring Cluster Connectivity Manager up to the latest version?”
“Is my environment's CCM upgradeable in place?”
Tell an agent
Upgrade Cluster Connectivity Manager on {environment}.
Move {environment} to the latest CCM version.
POST /api/v1/environments2/rotateSaltPassword Rotate the FreeIPA SaltStack password (deprecated) · Rotate SaltStack user password on FreeIPA instances #
Ask an LLM
“Is there a legacy call that rotates only the SaltStack password on FreeIPA?”
“Can I still rotate the FreeIPA Salt user password the old way?”
Tell an agent
Rotate the SaltStack password on FreeIPA in {environment} using the deprecated call.
Reset only the Salt user password on {environment}'s FreeIPA instances.
POST /api/v1/environments2/rotateFreeipaSecrets Rotate FreeIPA secrets · Rotate FreeIPA related secret for FreeIPA instances #
Ask an LLM
“How do I rotate secrets on my FreeIPA instances?”
“Can I choose which FreeIPA secret types get rotated?”
Tell an agent
Rotate FreeIPA secrets {secretTypes} in {environment}.
Rotate secret types {secretTypes} for FreeIPA on environment {environment}.
POST /api/v1/environments2/listFreeipaSecretTypes List FreeIPA secret types · Lists all FreeIPA related secret types #
Ask an LLM
“Which FreeIPA secret types can be rotated?”
“What secrets does FreeIPA manage in my environment?”
Tell an agent
List FreeIPA secret types for {environment}.
Show rotatable FreeIPA secrets in {environment}.
POST /api/v1/environments2/updateOrchestratorState Run an orchestrator state update on FreeIPA · Run orchestrator engine state update on the FreeIPA cluster #
Ask an LLM
“Can I re-apply the orchestrator engine state on my FreeIPA cluster?”
“How is a FreeIPA Salt state update triggered?”
Tell an agent
Run an orchestrator state update on FreeIPA in {environment}.
Reapply orchestrator state to {environment}'s FreeIPA cluster.
POST /api/v1/environments2/updateProxyConfig Change or remove an environment's proxy · Updates the proxy config of the given environment. #
Ask an LLM
“Can I attach a different proxy config to an existing environment?”
“How do I remove the proxy from an environment?”
Tell an agent
Attach proxy config {proxyConfigName} to environment {environment}.
Remove the proxy from environment {environment}.
POST /api/v1/environments2/updateAzureImageTermsPolicy Set the Azure Marketplace image terms policy · Updates account level Azure Marketplace image policy. #
Ask an LLM
“Can CDP automatically accept Azure Marketplace image terms for me?”
“How do I opt out of automatic Azure image terms acceptance?”
Tell an agent
Set automatic Azure Marketplace image terms acceptance to {accepted}.
Update the account Azure image terms policy to accepted={accepted}.
POST /api/v1/environments2/getAzureImageTermsPolicy Get the Azure Marketplace image terms policy · Gets account level Azure Marketplace image policy. #
Ask an LLM
“Is automatic acceptance of Azure Marketplace image terms turned on for my account?”
“What's my current Azure image terms setting?”
Tell an agent
Get my Azure Marketplace image terms policy.
Show whether Azure image terms are auto-accepted.
POST /api/v1/environments2/updateDataServiceResources Update data service resources of an environment · Updates Data Service resources of an environment #
Ask an LLM
“Can I change the data service resources configured on an environment?”
“Where do I update an environment's data services settings?”
Tell an agent
Update data service resources on {environment} to {dataServices}.
Set data services {dataServices} for environment {environment}.
POST /api/v1/environments2/updateCustomDockerRegistry Set an environment's custom Docker registry · Updates custom docker registry CRN of an environment #
Ask an LLM
“Can my environment pull images from a custom Docker registry?”
“How do I change the Docker registry CRN on an environment?”
Tell an agent
Set custom Docker registry {customDockerRegistry} on {environment}.
Point environment {environment} at registry {customDockerRegistry}.
POST /api/v1/environments2/updateFreeipaToAwsImdsV2 Switch FreeIPA on AWS to IMDSv2 · Updates FreeIPA AWS cluster to use IMDSv2 #
Ask an LLM
“How do I enforce IMDSv2 on my FreeIPA AWS instances?”
“Can FreeIPA be moved to the more secure instance metadata service?”
Tell an agent
Update FreeIPA in {environmentCrn} to use IMDSv2.
Enforce IMDSv2 on the FreeIPA cluster of {environmentCrn}.
POST /api/v1/environments2/updateFreeipaToAwsImdsV1 Revert FreeIPA on AWS to IMDSv1 · Updates FreeIPA AWS cluster to use IMDSv1 #
Ask an LLM
“Can I roll FreeIPA back to IMDSv1 on AWS?”
“Is downgrading FreeIPA's instance metadata to version 1 supported?”
Tell an agent
Update FreeIPA in {environmentCrn} to use IMDSv1.
Revert the FreeIPA cluster of {environmentCrn} to IMDSv1.
POST /api/v1/environments2/initializeAWSComputeCluster Initialize a compute cluster for an AWS environment · Initialize compute cluster for AWS environment #
Ask an LLM
“How do I set up the compute cluster for an existing AWS environment?”
“Can I pass compute cluster settings when initializing on AWS?”
Tell an agent
Initialize the compute cluster for AWS environment {environmentName}.
Set up an AWS compute cluster in {environmentName} with configuration {computeClusterConfiguration}.
POST /api/v1/environments2/initializeAzureComputeCluster Initialize a compute cluster for an Azure environment · Initialize compute cluster for Azure environment #
Ask an LLM
“What's the way to initialize a compute cluster on an Azure environment?”
“Can I configure the Azure compute cluster as it's initialized?”
Tell an agent
Initialize the compute cluster for Azure environment {environmentName}.
Set up an Azure compute cluster in {environmentName} with configuration {computeClusterConfiguration}.
POST /api/v1/environments2/setupActiveDirectoryTrust Start FreeIPA to Active Directory trust setup · Setup cross-realm trust between FreeIPA and Active Directory #
Ask an LLM
“How do I set up cross-realm trust between FreeIPA and Active Directory?”
“Which KDC servers and realm are needed to begin an AD trust?”
Tell an agent
Set up AD trust for {environment} with KDC servers {kdcServers}, realm {kdcRealm}, remote environment {remoteEnvironmentCrn}.
Begin cross-realm trust from {environment} to realm {kdcRealm} via {kdcServers} using DNS {dnsServerIps}, remote env {remoteEnvironmentCrn}.
POST /api/v1/environments2/finishSetupTrust Complete cross-realm trust setup · Complete cross-realm trust setup for FreeIPA #
Ask an LLM
“I've configured the Active Directory side; how do I finish the trust?”
“Does finishing the trust setup test both directions?”
Tell an agent
Finish the cross-realm trust setup for {environment}.
Complete and validate the AD trust on {environment}.
POST /api/v1/environments2/cancelTrust Cancel cross-realm trust setup · Cancel cross-realm trust for FreeIPA #
Ask an LLM
“Can I abandon a FreeIPA to Active Directory trust setup?”
“What's the way to back out of a cross-realm trust?”
Tell an agent destructive · confirm first
Cancel the cross-realm trust for {environment}.
Abort the Active Directory trust setup on {environment}.
POST /api/v1/environments2/repairTrust Repair cross-realm trust with Active Directory · Repair cross-realm trust of FreeIPA with an Active Directory Server #
Ask an LLM
“My FreeIPA trust with Active Directory is broken; can it be repaired?”
“Does repairing the trust reset the trust secret?”
Tell an agent
Repair the Active Directory trust for {environment}.
Reset the FreeIPA trust secret for {environment}.
POST /api/v1/environments2/getTrustSetupCommands Get commands to set up cross-realm trust · Lists the commands to be executed for cross-realm trust setup #
Ask an LLM
“Which commands do I run on the Active Directory side to set up trust?”
“What steps remain for the AD trust after I start it?”
Tell an agent
List the trust setup commands for {environment}.
Show the AD-side setup commands for {environment}'s trust.
POST /api/v1/environments2/getTrustCleanupCommands Get commands to clean up cross-realm trust · Gets the commands to be run for cross-realm trust clean up #
Ask an LLM
“What commands remove the trust configuration from Active Directory?”
“Which cleanup steps follow cancelling a cross-realm trust?”
Tell an agent
Get the trust cleanup commands for {environment}.
Show the AD cleanup commands for {environment}'s trust.

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-environments2-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-azure-environment-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-awsenvironment-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-awsgov-cloud-environment-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-gcpenvironment-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-collect-freeipa-diagnostics-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-private-environment-request-schema.json

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:cloudera-environments2-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-environments2-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.9.163
  title: Cloudera Environments Service Environments2 API
  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
tags:


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