How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cloudera Data Engineering API

Enable and manage Cloudera Data Engineering services and their virtual clusters. 24 operations.

Cloudera Data Engineering API is one of 24 APIs that Cloudera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Engineering, Spark, and Virtual Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 24 operations across 24 paths, and defines 65 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.

24 operations 24 paths 65 schemas 24 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
0.9.163
Base URL
https://api.us-west-1.cdp.cloudera.com
License
Apache 2.0
Terms of Service
Resource Areas
1

Paths & Operations 24

Across 24 paths, the API surfaces 24 operations — 24 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 24
POST
/api/v1/de/createBackup
Backup Cloudera Data Engineering(CDE) Service
createBackup 1 param → 200default
POST
/api/v1/de/cancelBackup
Cancel Cloudera Data Engineering(CDE) Service Backup
cancelBackup 1 param → 200default
POST
/api/v1/de/deleteBackup
Delete Cloudera Data Engineering(CDE) Service Backup
deleteBackup 1 param → 200default
POST
/api/v1/de/describeBackup
Describe Cloudera Data Engineering(CDE) Service Backup
describeBackup 1 param → 200default
POST
/api/v1/de/getBackupLogs
Retrieve Cloudera Data Engineering(CDE) Service Backup Logs
getBackupLogs 1 param → 200default
POST
/api/v1/de/getServiceInitLogs
Retrieve Cloudera Data Engineering(CDE) Service Initialization Logs
getServiceInitLogs 1 param → 200default
POST
/api/v1/de/listBackups
List Cloudera Data Engineering(CDE) Service Backups
listBackups 1 param → 200default
POST
/api/v1/de/restoreService
Restore Cloudera Data Engineering(CDE) Service
restoreService 1 param → 200default
POST
/api/v1/de/createVc
Create Virtual Cluster
createVc 1 param → 200default
POST
/api/v1/de/deleteVc
Delete Virtual Cluster
deleteVc 1 param → 200default
POST
/api/v1/de/updateVc
Update Cloudera Data Engineering (CDE) Virtual Cluster
updateVc 1 param → 200default
POST
/api/v1/de/describeService
Describe Cloudera Data Engineering(CDE) Service
describeService 1 param → 200default
POST
/api/v1/de/describeVc
Describe Virtual Cluster
describeVc 1 param → 200default
POST
/api/v1/de/disableService
Disable Cloudera Data Engineering(CDE) Service
disableService 1 param → 200default
POST
/api/v1/de/enableService
Enable Cloudera Data Engineering(CDE) Service
enableService 1 param → 200default
POST
/api/v1/de/updateService
Update Cloudera Data Engineering (CDE) Service
updateService 1 param → 200default
POST
/api/v1/de/upgradeService
Trigger a particular step (prepare, backup, upgrade, resume) of the upgrade framework.
upgradeService 1 param → 200default
POST
/api/v1/de/getUpgradeStatus
Get CDE Service Upgrade Status.
getUpgradeStatus 1 param → 200default
POST
/api/v1/de/getKubeconfig
Get Kubeconfig for the CDE service
getKubeconfig 1 param → 200default
POST
/api/v1/de/listServices
List Cloudera Data Engineering(CDE) Services
listServices 1 param → 200default
POST
/api/v1/de/listVcs
List Virtual Clusters
listVcs 1 param → 200default
POST
/api/v1/de/suspendVc
Initiates suspend on the requested VC.
suspendVc 1 param → 200default
POST
/api/v1/de/resumeVc
Initiates resume on the requested VC.
resumeVc 1 param → 200default
POST
/api/v1/de/getSuspendResumeStatus
Get CDE Service Suspend Resume Status.
getSuspendResumeStatus 1 param → 200default

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are EnableServiceRequest (36 properties), ServiceDescription (27 properties), VcDescription (22 properties), CreateVcRequest (18 properties). Each schema is shown below with its type and property counts.

Error
object
An object returned on an error.
2 properties
ServiceSummary
object
Summary of a CDE service.
6 properties 4 required
ServiceDescription
object
Detailed description of a CDE service.
27 properties 3 required
ServiceResources
object
Object to store resources for a CDE service.
12 properties
VcSummary
object
CDE virtual cluster summary.
7 properties 3 required
VcDescription
object
CDE virtual cluster summary.
22 properties 3 required
VcResources
object
Object to store resources for a CDE service
4 properties
ChartValueOverridesRequest
object
Object containing chart value overrides for enabling a CDE service or creation of virtual clusters.
2 properties
ChartValueOverridesResponse
object
Response object containing chart value overrides.
2 properties
AllPurposeInstanceGroupDetailsResponse
object
Instance group details for the All purpose Tier.
8 properties
SmtpConfigRequest
object
SMTP config request object.
7 properties 2 required
SmtpConfigResponse
object
SMTP config response object
6 properties 2 required
AccessControlResponse
object
Response object containing access control information for a Virtual Cluster.
5 properties
ListServicesRequest
object
Request object for ListServices method.
1 property
EnableServiceRequest
object
Request object for Enable Service method.
36 properties 5 required
CustomAzureFilesConfigs
object
Override Azure Files Configs.
3 properties 2 required
EnableServiceResponse
object
Response object for EnableService request.
1 property
UpdateServiceRequest
object
Request object for UpdateService method.
11 properties 1 required
UpgradeServiceRequest
object
Request object for upgrading a service.
2 properties 2 required
UpgradeServiceResponse
object
Response object for UpgradeService request.
1 property
GetUpgradeStatusRequest
object
Request object for GetUpgradeStatus method.
1 property 1 required
GetUpgradeStatusResponse
object
Response object for GetUpgradeStatus request.
3 properties
UpdateServiceResponse
object
Response object for UpdateService request.
2 properties
ListServicesResponse
object
Response object for ListServices method.
1 property
DescribeServiceRequest
object
Request object for DescribeService method.
1 property 1 required
DescribeServiceResponse
object
Response object for DescribeService method.
1 property
DisableServiceRequest
object
DisableService request object.
2 properties 1 required
DisableServiceResponse
object
DisableService response object.
1 property
GetKubeconfigRequest
object
GetKubeconfig request object.
1 property 1 required
GetKubeconfigResponse
object
GetKubeconfig response object.
1 property
ListVcsRequest
object
ListVcs request object.
1 property 1 required
ListVcsResponse
object
ListVcs response object.
1 property
DescribeVcRequest
object
DescribeVc request object.
2 properties 2 required
DescribeVcResponse
object
DescribeVc response object.
1 property
CreateVcRequest
object
Request object for CreateVc method.
18 properties 4 required
CreateVcResponse
object
Response object for CreateVc method.
1 property
DeleteVcRequest
object
Request object for DeleteVc method.
2 properties 2 required
DeleteVcResponse
object
Response object for DeleteVc method.
1 property
UpdateVcRequest
object
Request object for updateVc method.
10 properties 2 required
UpdateVcResponse
object
Response object for updateVc method.
1 property
CreateBackupRequest
object
Request object for Create Backup command.
7 properties 1 required
BackupContentOptions
object
Backup virtual cluster content options.
11 properties
CreateBackupResponse
object
Response object for Create Backup command.
1 property 1 required
CancelBackupRequest
object
Request object for Cancel Backup command.
1 property 1 required
CancelBackupResponse
object
Response object for Cancel Backup command.
DeleteBackupRequest
object
Request object for Delete Backup command.
1 property 1 required
DeleteBackupResponse
object
Response object for Delete Backup command.
DescribeBackupRequest
object
Request object for Describe Backup command.
1 property 1 required
DescribeBackupResponse
object
Response object for Describe Backup command.
1 property 1 required
Backup
object
Service backup object.
15 properties 11 required
GetBackupLogsRequest
object
Request object for Get Backup Logs command.
3 properties 1 required
GetBackupLogsResponse
object
Response object for the Get Backup Logs command.
2 properties 1 required
GetServiceInitLogsRequest
object
Request object for Get Service Init Logs command.
3 properties 1 required
GetServiceInitLogsResponse
object
Response object for the Get Service Init Logs command.
2 properties 1 required
ListBackupsRequest
object
Request object for List Backups command.
5 properties
ListBackupsResponse
object
Response object for List Backups command.
2 properties 1 required
Order
string
Order.
RestoreServiceRequest
object
Request object for Restore Service command.
5 properties 2 required
RestoreServiceResponse
object
Response object for Restore Service command.
1 property 1 required
SuspendVcRequest
object
Request object for suspending a virtual cluster.
2 properties 2 required
ResumeVcRequest
object
Request object for suspending a virtual cluster.
2 properties 2 required
SuspendVcResponse
object
Response object for SuspendVc request.
1 property
ResumeVcResponse
object
Response object for ResumeVc request.
1 property
GetSuspendResumeStatusRequest
object
Request object for GetSuspendResumeStatus method.
2 properties 1 required
GetSuspendResumeStatusResponse
object
Response object for GetSuspendResumeStatus request.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudera-de-openapi.yml Raw ↑

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 DataFlow API
Cloudera DataFlow Workload API
Cloudera Control Plane Data Recovery API
Cloudera Data Warehouse API
Cloudera Environments API
Where this information came from

This is an independent, third-party profile of Cloudera Data Engineering 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.