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.
Cloudera Environments API is one of 24 APIs that Cloudera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Environments, Cloud, and Credentials. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 104 operations across 104 paths, and defines 293 schemas. It is described by OpenAPI 2.0, at version 0.9.163.
Requests are made against the base URL https://api.us-west-1.cdp.cloudera.com.
104 operations
104 paths
293 schemas
104 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 104
Across 104 paths, the API surfaces 104 operations — 104 POST. Each is listed below with its method, path, parameters, and response codes.
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 created.
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 provider account.
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 your cloud provider…
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 provider account.
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 within your cloud pr…
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 provider account.
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 provider account.
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 SSH key were added.…
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 were added. All the e…
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 after the new securi…
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 were added. All the…
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 proxy configs were a…
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 your account to opt i…
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 account to opt in o…
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.
Schemas 293
The contract defines 293 schemas that model the data the API accepts and returns. The most detailed are CreateAzureEnvironmentRequest (31 properties), Environment (28 properties), CreateAWSEnvironmentRequest (25 properties), CreateAWSGovCloudEnvironmentRequest (23 properties). Each schema is shown below with its type and property counts.
CancelTrustRequest
object
Request object to cancel an existing trust.
1 property
1 required
CancelTrustResponse
object
Response object to cancel an existing trust.
2 properties
1 required
RepairTrustRequest
object
Request object to repair an existing trust.
1 property
1 required
RepairTrustResponse
object
Response object to repair an existing trust.
2 properties
1 required
GetTrustSetupCommandsRequest
object
Request object to get trust setup commands.
1 property
1 required
GetTrustSetupCommandsResponse
object
Response object to get trust setup commands.
4 properties
4 required
ActiveDirectoryCommands
object
Commands to be run on the Active Directory server.
1 property
1 required
BaseClusterCommands
object
The commands to be run on the base cluster for trust setup.
1 property
1 required
GetTrustCleanupCommandsRequest
object
Request object to show trust clean up commands.
1 property
1 required
GetTrustCleanupCommandsResponse
object
Response object to get trust clean up commands.
4 properties
4 required
FinishSetupTrustRequest
object
Request object to create an Trust finish setup command.
1 property
1 required
FinishSetupTrustResponse
object
Response object for Finish Setting up Trust.
2 properties
1 required
SetupActiveDirectoryTrustRequest
object
Request object to Setting up Active Directory Trust.
6 properties
4 required
KdcServerRequest
object
Key Distribution Center (KDC) server properties.
2 properties
2 required
SetupActiveDirectoryTrustResponse
object
Response object for Setting up Active Directory Trust.
1 property
1 required
Error
object
An object returned on an error.
2 properties
UpdateSshKeyRequest
object
The request object for updating the environment SSH key.
3 properties
1 required
UpdateSshKeyResponse
object
Response object for an update environment SSH key request.
1 property
1 required
UpdateSubnetRequest
object
The request for updating subnets of the given environment.
3 properties
1 required
UpdateSubnetResponse
object
Response object for an update environment subnet request.
1 property
1 required
UpdateSecurityAccessRequest
object
The request object for updating security access of the given environment.
3 properties
3 required
UpdateSecurityAccessResponse
object
Response object for an update environment security access request.
1 property
1 required
UpdateTagsRequest
object
The request object for updating the tags of the given environment.
2 properties
2 required
UpdateTagsResponse
object
Response object for an update environment tags request.
1 property
1 required
CreateAWSCredentialResponse
object
Response object for a create AWS credential request.
1 property
1 required
CreateAWSCredentialRequest
object
Request object for a create AWS credential request.
3 properties
2 required
CreateAWSGovCloudCredentialRequest
object
Request object for a create AWS credential request for GovCloud.
3 properties
2 required
CreateAWSGovCloudCredentialResponse
object
Response object for a create AWS credential request for GovCloud.
1 property
1 required
CreateAzureCredentialRequest
object
Request object for a create Azure credential request.
5 properties
2 required
UpdateAzureCredentialRequest
object
Request object for an update Azure credential request.
5 properties
4 required
UpdateAwsCredentialRequest
object
Request object for an update AWS credential request.
5 properties
2 required
UpdateAwsCredentialResponse
object
Response object for an update AWS credential request.
1 property
CreateGCPCredentialResponse
object
Response object for a create GCP credential request.
1 property
1 required
CreateGCPCredentialRequest
object
Request object for a create GCP credential request.
3 properties
2 required
CreateAzureCredentialResponse
object
Response object for a create Azure credential request.
1 property
1 required
Credential
object
A credential object.
10 properties
3 required
UpdateAzureCredentialResponse
object
Response object for an update Azure credential request.
1 property
AwsCredentialProperties
object
The credential properties that closely related to those that have been created on AWS.
2 properties
AzureCredentialProperties
object
The credential properties that closely related to those that have been created on Azure.
5 properties
AzureAuthenticationTypeProperties
string
Authentication type of the credential
AzureCredentialCertificateProperties
object
The certificate used for the credential
5 properties
GCPCredentialProperties
object
The credential properties that closely related to those that have created on GCP.
1 property
GetCredentialPrerequisitesRequest
object
Request object for getting the credential prerequisites for the given cloud platform.
1 property
1 required
GetCredentialPrerequisitesResponse
object
The credential prerequisites for AWS.
4 properties
1 required
AwsCredentialPrerequisitesResponse
object
Response object for getting AWS credential prerequisites.
3 properties
2 required
AzureCredentialPrerequisitesResponse
object
Response object for getting Azure credential prerequisites.
3 properties
2 required
GcpCredentialPrerequisitesResponse
object
Response object for getting GCP credential prerequisites.
1 property
1 required
GetGovCloudCredentialPrerequisitesRequest
object
Request object for getting the credential prerequisites for GovCloud for the enabled providers.
1 property
1 required
GetGovCloudCredentialPrerequisitesResponse
object
The credential prerequisites for GovCloud for the enabled providers.
2 properties
CredentialGranularPolicyResponse
object
Response object for the granular policy for the given service or experience.
2 properties
2 required
InitializeAWSComputeClusterRequest
object
Request object for a initialize AWS default compute cluster.
2 properties
1 required
InitializeAzureComputeClusterRequest
object
Request object for a initialize Azure default compute cluster.
2 properties
1 required
CreateAWSEnvironmentRequest
object
Request object for a create AWS environment request.
25 properties
6 required
CreateAWSGovCloudEnvironmentRequest
object
Request object for a create AWS GovCloud environment request.
23 properties
6 required
CreateAWSGovCloudEnvironmentResponse
object
Response object for a create AWS GovCloud environment request.
1 property
1 required
CreatePrivateEnvironmentRequest
object
Request object for a create private cloud environment request.
15 properties
5 required
CheckEnvironmentConnectivityRequest
object
Request object to check connectivity to private cloud environment.
5 properties
3 required
AwsLogStorageRequest
object
AWS storage configuration for cluster and audit logs.
3 properties
2 required
AzureLogStorageRequest
object
Azure storage configuration for cluster and audit logs.
3 properties
2 required
GcpLogStorageRequest
object
GCP storage configuration for cluster and audit logs.
3 properties
2 required
LogStorage
object
Storage configuration for cluster and audit logs.
4 properties
1 required
BackupStorage
object
Storage configuration for backup.
4 properties
SecurityAccessRequest
object
Security control configuration for FreeIPA and Datalake deployment. Choosing a CIDR will automatically create security groups. Alternatively existing security…
5 properties
GcpSecurityAccessRequest
object
Firewall rules for FreeIPA, Data Lake and Data Hub deployment.
2 properties
SecurityAccess
object
Security control configuration for FreeIPA and Datalake deployment.
3 properties
CreateAWSEnvironmentResponse
object
Response object for a create AWS environment request.
1 property
1 required
InitializeAWSComputeClusterResponse
object
Response object for an initialize AWS default compute cluster request.
1 property
InitializeAzureComputeClusterResponse
object
Response object for an initialize Azure default compute cluster request.
1 property
CreateAzureEnvironmentResponse
object
Response object for a create Azure environment request.
1 property
1 required
CreateGCPEnvironmentResponse
object
Response object for a create GCP environment request.
1 property
1 required
CreatePrivateEnvironmentResponse
object
Response object for a create private cloud environment request.
1 property
1 required
CheckEnvironmentConnectivityResponse
object
Response object to check connectivity to private cloud environment.
1 property
1 required
ListEnvironmentsRequest
object
Request object for a list environments request.
ListEnvironmentsResponse
object
Response object for a list environments request.
1 property
1 required
ListCredentialsRequest
object
Request object for a list credentials request.
1 property
ListCredentialsResponse
object
Response object for a list credentials request.
1 property
1 required
CreateAzureEnvironmentRequest
object
Request object for a create Azure environment request.
31 properties
8 required
CreateGCPEnvironmentRequest
object
Request object for a create GCP environment request.
20 properties
6 required
ExistingAzureNetworkRequest
object
Request object for creating an Azure environment using existing VNet and subnets.
5 properties
3 required
ExistingGCPNetworkRequest
object
Request object for creating an GCP environment using existing VPC and subnets.
3 properties
2 required
ChangeEnvironmentCredentialRequest
object
Request object for a change environment credentials request.
2 properties
2 required
ChangeEnvironmentCredentialResponse
object
Response object for a change environment credentials request.
1 property
1 required
UpdateAzureEncryptionResourcesRequest
object
Request object for updating Azure encryption resources.
4 properties
2 required
UpdateAzureEncryptionResourcesResponse
object
Response object for a update Azure encryption resources request.
2 properties
1 required
UpdateAzureDatabaseResourcesRequest
object
Request object for updating Azure Database resources.
3 properties
1 required
UpdateAzureDatabaseResourcesResponse
object
Response object for a update Azure Database resources request.
2 properties
1 required
UpdateAzureAvailabilityZonesRequest
object
Request object to update Availability Zones for Azure environment.
2 properties
2 required
UpdateAzureAvailabilityZonesResponse
object
Response object for a update Azure Availability Zones request.
1 property
1 required
UpdateAwsDiskEncryptionParametersRequest
object
Request object for updating AWS encryption parameters.
2 properties
2 required
UpdateAwsDiskEncryptionParametersResponse
object
Response object for an update AWS encryption parameters request.
2 properties
1 required
AwsDiskEncryptionParameters
object
Object containing details of encryption parameters for AWS cloud.
1 property
AzureResourceEncryptionParameters
object
Object containing details of encryption parameters for Azure cloud.
4 properties
AzureDatabaseResources
object
Object containing details of database resources for Azure cloud.
2 properties
DescribeEnvironmentRequest
object
Request object for a describe environment request.
1 property
1 required
DescribeEnvironmentResponse
object
Response object for a describe environment request.
1 property
1 required
EnvironmentSummary
object
The environment summary.
10 properties
6 required
Environment
object
The environment.
28 properties
8 required
AuthenticationRequest
object
Additional SSH key authentication configuration for accessing cluster node.
2 properties
Authentication
object
Additional SSH key authentication configuration for accessing cluster node instances.
3 properties
Network
object
The network.
9 properties
2 required
CloudSubnet
object
Information about a cloud provider subnet.
4 properties
NetworkAwsParams
object
AWS network parameters.
1 property
1 required
NetworkAzureParams
object
Azure network parameters.
7 properties
3 required
NetworkGcpParams
object
GCP network parameters.
3 properties
2 required
DeleteEnvironmentRequest
object
Request object for a delete environment request.
3 properties
1 required
DeleteEnvironmentResponse
object
Response object for a delete environment request.
StartEnvironmentRequest
object
Request object for a start environment request.
2 properties
1 required
StartEnvironmentResponse
object
Response object for a start environment request.
1 property
StopEnvironmentRequest
object
Request object for a stop environment request.
1 property
1 required
StopEnvironmentResponse
object
Response object for a stop environment request.
1 property
DeleteCredentialRequest
object
Request object for a delete credential request.
1 property
1 required
DeleteCredentialResponse
object
Response object for a delete credential request.
SyncAllUsersRequest
object
Request object for a All Users and Groups Sync.
1 property
SyncAllUsersResponse
object
All Users and Groups Sync Response Object
10 properties
1 required
SyncUserRequest
object
Request Object for single user sync operation.
SyncUserResponse
object
Response Object for single user sync operation.
10 properties
1 required
SetPasswordRequest
object
Request object for set password request. (deprecated)
2 properties
1 required
SetPasswordResponse
object
Response object for set password request. (deprecated)
10 properties
1 required
SyncStatusRequest
object
Request object for Sync Status.
1 property
1 required
SyncStatusResponse
object
Response object for Sync Operation.
10 properties
1 required
LastSyncStatusRequest
object
Request object for Sync Status.
2 properties
ListConnectedDataServicesRequest
object
Request object for listing connected Data Service(s) for a given environment.
1 property
1 required
ListConnectedDataServicesResponse
object
Response object for listing connected Data Service(s) for a given environment.
1 property
1 required
ConnectedDataService
object
A single entry that contains the name of the given Data Service and its related resource(s).
2 properties
2 required
LastSyncStatusResponse
object
Response object for Sync Operation.
8 properties
1 required
GetEnvironmentUserSyncStateRequest
object
Request object for retrieving the user sync state of an environment.
1 property
1 required
GetEnvironmentUserSyncStateResponse
object
Response object for retrieving the user sync state of an environment.
2 properties
1 required
GetRootCertificateRequest
object
Request object for obtaining public certificate of an environment.
1 property
1 required
GetRootCertificateResponse
object
Response object with base64 encoded contents of the public certificate for an environment.
1 property
GetKeytabRequest
object
Request object for get keytab request.
2 properties
1 required
GetKeytabResponse
object
Request object for get keytab request.
1 property
GetAutomatedSyncEnvironmentStatusRequest
object
Request object for getting automated sync environment status.
1 property
1 required
GetAutomatedSyncEnvironmentStatusResponse
object
Response object for getting automated sync environment status.
3 properties
GetIdBrokerMappingsRequest
object
Request object for getting ID Broker mappings for an environment.
1 property
1 required
GetIdBrokerMappingsResponse
object
Response object for getting ID Broker mappings for an environment.
6 properties
3 required
SetIdBrokerMappingsRequest
object
Request object for setting ID Broker mappings for an environment. Overwrites all existing mappings.
7 properties
2 required
SetIdBrokerMappingsResponse
object
Response object for setting ID Broker mappings for an environment.
6 properties
3 required
SyncIdBrokerMappingsRequest
object
Request object for synchronizing ID Broker mappings for an environment.
1 property
1 required
SyncIdBrokerMappingsResponse
object
Response object for synchronizing ID Broker mappings for an environment.
GetIdBrokerMappingsSyncStatusRequest
object
Request object for getting ID Broker mappings sync status.
1 property
1 required
GetIdBrokerMappingsSyncStatusResponse
object
Response object for getting ID Broker mappings sync status.
3 properties
3 required
IdBrokerMapping
object
A mapping of an actor or group to a cloud provider role.
2 properties
2 required
IdBrokerMappingRequest
object
A mapping of an actor or group to a cloud provider role, used in request objects.
2 properties
2 required
IdBrokerSyncStatus
object
Status of an ID Broker mappings sync operation.
4 properties
1 required
SyncOperationDetails
object
Details object of the sync operation for success or falure.
2 properties
1 required
SyncStatus
string
Status of a sync operation.
OperationType
string
Operation Type.
RepairOperationDetails
object
Details object of the repair operation for success or falure.
2 properties
1 required
RepairStatus
string
Status of a repair operation.
GetOperationRequest
object
Request object for tracking the latest (current/last) operation on the environment resource.
2 properties
1 required
GetOperationResponse
object
Response object for tracking the latest (current/last) operation on the environment resource.
5 properties
ExposedService
object
Exposed CDP DC service object.
7 properties
CdpCluster
object
Discovered CdpCluster object.
6 properties
EnvValidation
object
Object for validating services.
2 properties
CheckKubernetesConnectivityRequest
object
Request object for checking Kubernetes connectivity.
2 properties
1 required
CheckKubernetesConnectivityResponse
object
Response object for checking Kubernetes connectivity.
2 properties
1 required
CheckDatabaseConnectivityRequest
object
Request object for checking Database connectivity.
5 properties
5 required
CheckDatabaseConnectivityResponse
object
Response object for checking Database connectivity.
2 properties
1 required
GetFreeipaStatusRequest
object
Request object for getting the status of the FreeIPA servers.
1 property
1 required
FreeIPANodeStatus
object
The status and issues of an individual FreeIPA node.
4 properties
2 required
GetFreeipaStatusResponse
object
The overall status of the FreeIPA cluster.
4 properties
4 required
AttachFreeIpaRecipesRequest
object
Request object for attaching recipes to FreeIPA.
2 properties
2 required
AttachFreeIpaRecipesResponse
object
Response object for attaching recipes to FreeIPA.
DetachFreeIpaRecipesRequest
object
Request object for detaching recipes from FreeIPA.
2 properties
2 required
DetachFreeIpaRecipesResponse
object
Response object for detaching recipes from FreeIPA.
RepairFreeipaRequest
object
Request object for repairing the FreeIPA servers.
4 properties
1 required
RepairFreeipaResponse
object
Response object for an FreeIPA repair request.
7 properties
GetRepairFreeipaStatusRequest
object
Request object for Repair Status.
1 property
1 required
GetRepairFreeipaStatusResponse
object
Response object for Repair Operation.
6 properties
AWSFreeIpaCreationRequest
object
Request object for creating FreeIPA in the environment.
5 properties
AzureFreeIpaCreationRequest
object
Request object for creating FreeIPA in the environment.
4 properties
GCPFreeIpaCreationRequest
object
Request object for creating FreeIPA in the environment.
4 properties
FreeIpaImageRequest
object
Request object for FreeIPA image.
3 properties
TagRequest
object
A label that can be attached to some resources.
2 properties
2 required
GcpTagRequest
object
A label that can be attached to GCP resources. Please refer to Google documentation for the rules https://cloud.google.com/compute/docs/labeling-resourceslabel…
2 properties
2 required
FreeipaDetails
object
Details of a FreeIPA cluster.
10 properties
FreeIpaInstance
object
Object for a FreeIPA instance providing specific information about the instance.
14 properties
FreeIpaLoadBalancer
object
Details of a FreeIPA load balancer.
3 properties
AWSComputeClusterConfigurationRequest
object
Request object for creating Externalized compute cluster for the environment.
3 properties
AzureComputeClusterConfigurationRequest
object
Request object for creating Externalized compute cluster for the environment.
4 properties
AWSComputeClusterConfiguration
object
Externalized compute cluster configuration for the environment.
3 properties
AzureComputeClusterConfiguration
object
Externalized compute cluster configuration for the environment.
4 properties
AttachedVolumeDetail
object
The attached volume configuration.
3 properties
ProxyConfig
object
A proxy config object.
10 properties
5 required
CreateProxyConfigRequest
object
Request object for a create proxy config request.
8 properties
4 required
CreateProxyConfigResponse
object
Response object for a create proxy config request.
1 property
1 required
ListProxyConfigsRequest
object
Request object for a list proxy configs request.
1 property
ListProxyConfigsResponse
object
Response object for a list proxy configs request.
1 property
1 required
DeleteProxyConfigRequest
object
Request object for a delete proxy config request.
1 property
1 required
DeleteProxyConfigResponse
object
Response object for a delete proxy config request.
SetTelemetryFeaturesRequest
object
Request object to enable environment level telemetry features.
2 properties
1 required
SetTelemetryFeaturesResponse
object
Response object to enable environment level telemetry features.
UpdateAzureImageTermsPolicyRequest
object
Request object to enable or disable automatic acceptance of Azure Marketplace image terms.
1 property
1 required
UpdateAzureImageTermsPolicyResponse
object
Response object to enable or disable automatic acceptance of Azure Marketplace image terms.
GetAzureImageTermsPolicyRequest
object
Request object to retrieve current value of setting that controls automatic acceptance of Azure Marketplace image terms.
GetAzureImageTermsPolicyResponse
object
Response object to retrieve current value of setting that controls automatic acceptance of Azure Marketplace image terms.
1 property
1 required
GetEnvironmentSettingRequest
object
Request object to query environment configuration settings.
2 properties
1 required
GetEnvironmentSettingResponse
object
Response object containing configuration settings.
1 property
SetEnvironmentSettingRequest
object
Request object to set environment configuration settings.
2 properties
1 required
SetEnvironmentSettingResponse
object
Response object to set configuration.
SetAccountTelemetryRequest
object
Request object to enable environment level telemetry features.
2 properties
SetAccountTelemetryResponse
object
Response object for set account level telemetry settings.
2 properties
GetAccountTelemetryRequest
object
Request object for get account level telemetry settings.
GetAccountTelemetryResponse
object
Response object for get account level telemetry settings.
2 properties
GetAccountTelemetryDefaultRequest
object
Request object for get default account level telemetry settings.
GetAccountTelemetryDefaultResponse
object
Response object for get default account level telemetry settings.
2 properties
AnonymizationRuleRequest
object
Anonymization rule request object that is applied on logs that are sent to Cloudera.
2 properties
1 required
AnonymizationRuleResponse
object
Anonymization rule response object rule that is applied on logs that are sent to Cloudera.
2 properties
TestAccountTelemetryRulesRequest
object
Request object for testing text input against provided account telemetry anonymization rules.
2 properties
2 required
TestAccountTelemetryRulesResponse
object
Response object for testing anonymization rules for account telemetry.
1 property
FreeipaVmLogRequest
object
Log descriptor, contains a path and label pair. Used for diagnostics collections.
2 properties
2 required
FreeipaVmLogResponse
object
Log descriptor, contains a path and label pair. Used for diagnostics collections.
2 properties
CollectFreeipaDiagnosticsRequest
object
Request object for collecting FreeIPA diagnostics.
17 properties
3 required
CollectFreeipaDiagnosticsResponse
object
Response object for collecting FreeIPA diagnostics.
1 property
ListFreeipaDiagnosticsRequest
object
Request object for listing recent FreeIPA diagnostics collections.
1 property
1 required
ListFreeipaDiagnosticsResponse
object
Response object for listing recent FreeIPA diagnostics collections.
1 property
FreeipaDiagnosticsCollectionResponse
object
Response object for diagnostic collection flow details.
6 properties
FreeipaDiagnosticsCollectionDetailsResponse
object
Response object for diagnostic collection details.
7 properties
CancelFreeipaDiagnosticsRequest
object
Request object for cancel running FreeIPA diagnostics collections.
1 property
1 required
CancelFreeipaDiagnosticsResponse
object
Response object for cancel running FreeIPA diagnostics collections.
GetFreeipaLogDescriptorsRequest
object
Request object for obtaining log descriptors. (that are used for diagnostics collection)
GetFreeipaLogDescriptorsResponse
object
Response object for obtaining log descriptors. (useful for diagnostics collection filtering)
1 property
EnvironmentTags
object
Environment tags object containing the tag values defined for the environment.
2 properties
GetAuditCredentialPrerequisitesRequest
object
Request object for getting the audit credential prerequisites for the given cloud platform.
1 property
1 required
GetAuditCredentialPrerequisitesResponse
object
The audit credential prerequisites.
5 properties
1 required
GetGovCloudAuditCredentialPrerequisitesRequest
object
Request object for getting the audit credential prerequisites for GovCloud for the enabled providers.
1 property
1 required
GetGovCloudAuditCredentialPrerequisitesResponse
object
The audit credential prerequisites for GovCloud for the enabled providers.
2 properties
ListAuditCredentialsRequest
object
Request object for a list audit credentials request.
ListAuditCredentialsResponse
object
Response object for a list audit credentials request.
1 property
1 required
SetAWSAuditCredentialRequest
object
Request object for a set AWS audit credential request.
1 property
1 required
SetAWSAuditCredentialResponse
object
Response object for a set AWS audit credential request.
1 property
1 required
SetAWSGovCloudAuditCredentialRequest
object
Request object for a set AWS GovCloud audit credential request.
1 property
1 required
SetAWSGovCloudAuditCredentialResponse
object
Response object for a set AWS GovCloud audit credential request.
1 property
1 required
SetAzureAuditCredentialRequest
object
Request object for a set Azure audit credential request.
3 properties
3 required
SetAzureAuditCredentialResponse
object
Response object for a set Azure audit credential request.
1 property
1 required
SetGCPAuditCredentialRequest
object
Request object for a set GCP audit credential request.
1 property
1 required
SetGCPAuditCredentialResponse
object
Response object for a set GCP audit credential request.
1 property
1 required
DeleteAuditCredentialRequest
object
Request object for a delete audit credential request.
1 property
1 required
DeleteAuditCredentialResponse
object
Response object for a delete audit credential request.
SetEndpointAccessGatewayRequest
object
Request object to set endpoint access gateway settings.
3 properties
2 required
SetEndpointAccessGatewayResponse
object
Response object for set endpoint access gateway request.
1 property
LastAutomatedSyncDetails
object
The details of the last sync performed by automated user sync.
3 properties
2 required
ValidateAwsCloudStorageRequest
object
Request object for AWS environment cloud storage validation.
3 properties
3 required
ValidateAwsCloudStorageResponse
object
Response object for AWS environment cloud storage validation.
2 properties
ValidateAzureCloudStorageRequest
object
Request object for Azure environment cloud storage validation.
6 properties
2 required
ValidateAzureCloudStorageResponse
object
Response object for Azure environment cloud storage validation.
2 properties
SetCatalogRequest
object
The request object to set catalog for a FreeIPA.
2 properties
2 required
SetCatalogResponse
object
The response object to set catalog for a FreeIPA request.
UpgradeFreeipaRequest
object
The request object for FreeIPA upgrade.
3 properties
1 required
UpgradeFreeipaResponse
object
The response object for FreeIPA upgrade.
3 properties
GetFreeipaUpgradeOptionsRequest
object
The request object for retrieving FreeIPA upgrade candidates.
3 properties
1 required
GetFreeipaUpgradeOptionsResponse
object
The response object with available FreeIPA upgrade candidates.
2 properties
UpscaleFreeipaRequest
object
The request object for FreeIPA upscale.
2 properties
2 required
UpscaleFreeipaResponse
object
The response object for FreeIPA upscale.
3 properties
DownscaleFreeipaRequest
object
The request object for FreeIPA downscale. Either targetAvailabilityType or instances
4 properties
1 required
DownscaleFreeipaResponse
object
The response object for FreeIPA downscale.
3 properties
StartFreeIpaVerticalScalingRequest
object
The request object for FreeIPA vertical scaling.
2 properties
2 required
StartFreeIpaVerticalScalingResponse
object
The response object for FreeIPA vertical scaling.
2 properties
InstanceTemplate
object
Instance template that specifies the core information for the instances.
3 properties
AttachedVolume
object
The attached volume configuration.
3 properties
AwsFreeIpaInstanceTemplateParams
object
AWS specific FreeIPA parameters.
2 properties
ImageInfoResponse
object
Information about FreeIPA image.
6 properties
ImageInfo
object
Basic information about an image.
3 properties
RetryFreeipaRequest
object
Request object for retry FreeIPA request.
1 property
1 required
RetryFreeipaResponse
object
Response object for retry FreeIPA operation on an environment.
1 property
UpgradeCcmRequest
object
Request object for upgrading Cluster Connectivity Manager on an environment.
1 property
1 required
UpgradeCcmResponse
object
Response object for upgrading Cluster Connectivity Manager request on an environment.
1 property
RotateSaltPasswordRequest
object
Request object for rotating SaltStack user password on FreeIPA instances (Deprecated).
1 property
1 required
RotateSaltPasswordResponse
object
Response object for rotating SaltStack user password on FreeIPA instances (Deprecated).
1 property
RotateFreeipaSecretsRequest
object
Request object for starting secret rotation for FreeIPA.
2 properties
2 required
RotateFreeipaSecretsResponse
object
Response object for rotating secrets.
1 property
ListFreeipaSecretTypesRequest
object
Request for listing possible secret values for Freeipa.
1 property
1 required
ListFreeipaSecretTypesResponse
object
Response for listing possible secret values for Freeipa.
1 property
1 required
SecretTypeResponse
object
Response object for showing the secret types and descriptions.
2 properties
UpdateProxyConfigRequest
object
Request object for updating the proxy config of the given environment.
3 properties
1 required
UpdateProxyConfigResponse
object
Response object for updating the proxy config of the given environment.
UpdateOrchestratorStateRequest
object
Request object for running orchestrator engine state update on the FreeIPA cluster.
1 property
1 required
UpdateOrchestratorStateResponse
object
Response object for running orchestrator engine state update on the FreeIPA cluster.
1 property
DataServicesRequest
object
Data Services parameters request of the environment.
1 property
DataServices
object
Data Services parameters response of the environment.
1 property
AzureDataServicesParametersRequest
object
Azure-specific Data Service parameters request.
2 properties
1 required
AzureDataServicesParameters
object
Azure-specific Data Service parameters response.
1 property
1 required
UpdateDataServiceResourcesRequest
object
Update Data Services parameters request of the environment.
2 properties
2 required
UpdateDataServiceResourcesResponse
object
Response object for an update environment Data Service resource request.
1 property
1 required
CustomDockerRegistryRequest
object
The desired custom docker registry for data services to be used.
1 property
1 required
CustomDockerRegistryResponse
object
The configured custom docker registry for data services.
1 property
1 required
UpdateCustomDockerRegistryRequest
object
The desired custom docker registry for data services to be used.
2 properties
2 required
UpdateCustomDockerRegistryResponse
object
The environment with the updated custom docker registry for data services.
1 property
1 required
UpdateFreeipaToAwsImdsV2Request
object
The related environment where we update the corresponding FreeIPA to use AWS IMDSv2.
1 property
1 required
UpdateFreeipaToAwsImdsV2Response
object
Response object for updating corresponding FreeIPA of the given environment to AWS IMDSv2.
1 property
UpdateFreeipaToAwsImdsV1Request
object
The related environment where we update the corresponding FreeIPA to use AWS IMDSv1.
1 property
1 required
UpdateFreeipaToAwsImdsV1Response
object
Response object for updating corresponding FreeIPA of the given environment to AWS IMDSv1.
1 property
EnvironmentQuota
object
Resource pool quota for the Environment.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cloudera 12
Other APIs Cloudera publishes across the network.
Cloudera Audit Service API
Cloudera Private Links API
Cloudera Compute Service API
Cloudera Consumption API
Cloudera Data Catalog API
Cloudera Data Hub API
Cloudera Datalake API
Cloudera Data Engineering API
Cloudera DataFlow API
Cloudera DataFlow Workload API
Cloudera Control Plane Data Recovery API
Cloudera Data Warehouse API
#Environments#Cloud#Credentials
Where this information came from
This is an independent, third-party profile of Cloudera Environments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.