# Cloudera Df API

**Canonical:** https://apis.io/apis/cloudera/cloudera-df-api/  
**Provider:** Cloudera — https://apis.io/providers/cloudera/  
**Base URL:** https://api.us-west-1.cdp.cloudera.com  
**Documentation:** https://docs.cloudera.com/cdp-public-cloud/cloud/api/topics/mc-api-overview.html

Cloudera Df API is one of 24 APIs that [Cloudera](https://apis.io/providers/cloudera/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Df. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Df API from Cloudera — 66 operation(s) for df.

## Operations (60 of 66)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/df/addReadyflow` | Add ready flow |
| POST | `/api/v1/df/assignToCollection` | Assign a flow definition to collection |
| POST | `/api/v1/df/cancelDeleteProject` | Cancels deletion of a Project |
| POST | `/api/v1/df/createCollection` | Create catalog collection |
| POST | `/api/v1/df/createFlowVersionTag` | Create flow version tag |
| POST | `/api/v1/df/createProject` | Creates a Project |
| POST | `/api/v1/df/deleteAddedReadyflow` | Delete added ready flow |
| POST | `/api/v1/df/deleteCollection` | Delete catalog collection |
| POST | `/api/v1/df/deleteFlow` | Delete flow |
| POST | `/api/v1/df/deleteFlowVersionTag` | Delete flow version tag |
| POST | `/api/v1/df/deleteProject` | Deletes a Project |
| POST | `/api/v1/df/describeAddedReadyflow` | Describe added ready flow detail |
| POST | `/api/v1/df/describeCollection` | Describe catalog collection |
| POST | `/api/v1/df/describeDeployment` | Describe deployment |
| POST | `/api/v1/df/describeDeploymentEventDetail` | Describe event detail for deployment |
| POST | `/api/v1/df/describeFlow` | Describe flow |
| POST | `/api/v1/df/describeFlowEventDetailInDeployment` | Describe flow event detail in a deployment |
| POST | `/api/v1/df/describeFlowInDeployment` | Describe flow in a deployment |
| POST | `/api/v1/df/describeProject` | Describes a Project |
| POST | `/api/v1/df/describeReadyflow` | Describe ready flow |
| POST | `/api/v1/df/describeService` | Describe service |
| POST | `/api/v1/df/describeServiceEventDetail` | Describe event history detail for service |
| POST | `/api/v1/df/disableService` | Disable service |
| POST | `/api/v1/df/enableService` | Enable DataFlow service from a CDP environment |
| POST | `/api/v1/df/getFlowVersion` | Get flow version |
| POST | `/api/v1/df/getKubeconfig` | Get Kubeconfig |
| POST | `/api/v1/df/grantUserKubernetesAccess` | Grant remote user access to the service's cluster |
| POST | `/api/v1/df/importFlowDefinition` | Import a new flow definition |
| POST | `/api/v1/df/importFlowDefinitionVersion` | Import a new flow definition version to an existing flow |
| POST | `/api/v1/df/initiateDeployment` | Initiate a deployment creation |
| POST | `/api/v1/df/initiateFlowInDeployment` | Initiate the flow creation process in a deployment |
| POST | `/api/v1/df/listCollections` | List catalog collections |
| POST | `/api/v1/df/listDeployableServicesForNewDeployments` | List services that a DataFlow Admin can deploy to |
| POST | `/api/v1/df/listDeploymentActiveAlerts` | List active alerts for deployment |
| POST | `/api/v1/df/listDeploymentEvents` | List event history for deployment |
| POST | `/api/v1/df/listDeploymentKPIs` | List deployment KPIs |
| POST | `/api/v1/df/listDeploymentSystemMetrics` | List deployment System metrics |
| POST | `/api/v1/df/listDeployments` | List deployments |
| POST | `/api/v1/df/listDiagnostics` | List diagnostics |
| POST | `/api/v1/df/listFilterOptions` | List filter options |
| POST | `/api/v1/df/listFlowActiveAlertsInDeployment` | List active alerts for a flow in a deployment |
| POST | `/api/v1/df/listFlowDefinitionVersions` | List flow definition versions |
| POST | `/api/v1/df/listFlowDefinitions` | List flow definitions |
| POST | `/api/v1/df/listFlowEventsInDeployment` | List event history for a flow in a deployment |
| POST | `/api/v1/df/listFlowKpisInDeployment` | List KPI metrics for a flow in a deployment |
| POST | `/api/v1/df/listFlowVersionTags` | List flow version tags |
| POST | `/api/v1/df/listFlowsInDeployment` | List flows in a deployment |
| POST | `/api/v1/df/listNotifications` | List notifications |
| POST | `/api/v1/df/listProjectFilterOptions` | List filter options |
| POST | `/api/v1/df/listProjects` | List Projects |
| POST | `/api/v1/df/listReadyflows` | List ready flows |
| POST | `/api/v1/df/listServiceActiveAlerts` | List active alerts for service |
| POST | `/api/v1/df/listServiceEvents` | List events for service |
| POST | `/api/v1/df/listServiceSystemMetrics` | List service System metrics |
| POST | `/api/v1/df/listServices` | List services |
| POST | `/api/v1/df/listUserKubernetesAccess` | List users that have access to the service's cluster |
| POST | `/api/v1/df/renewCertificates` | Renew workload UI certificates |
| POST | `/api/v1/df/resetService` | Resets all references to a service. |
| POST | `/api/v1/df/revokeUserKubernetesAccess` | Revoke access for the remote user from the service's cluster |
| POST | `/api/v1/df/rotatePassword` | Rotate password |

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

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-df-api-openapi.yml
- **Documentation** — https://docs.cloudera.com/cdp-public-cloud/cloud/api/topics/mc-api-overview.html
- **APIReference** — https://cloudera.github.io/cdp-dev-docs/api-docs/

## Other Cloudera APIs (12)

- [Cloudera Manager API](https://apis.io/apis/cloudera/manager/)
- [Cloudera Cruise Control REST API](https://apis.io/apis/cloudera/cruise-control/)
- [Streams Replication Manager Service REST API](https://apis.io/apis/cloudera/srm/)
- [HBase REST Server](https://apis.io/apis/cloudera/hbase-rest/)
- [YARN Queue Manager API](https://apis.io/apis/cloudera/yarn-queue-manager/)
- [Cloudera Audit API](https://apis.io/apis/cloudera/cloudera-audit-api/)
- [Cloudera CDF Local RPCAPI Version1 API](https://apis.io/apis/cloudera/cloudera-cdflocalrpcapiversion1-api/)
- [Cloudera Cloudprivatelinks API](https://apis.io/apis/cloudera/cloudera-cloudprivatelinks-api/)
- [Cloudera Compute API](https://apis.io/apis/cloudera/cloudera-compute-api/)
- [Cloudera Consumption API](https://apis.io/apis/cloudera/cloudera-consumption-api/)
- [Cloudera Datalake API](https://apis.io/apis/cloudera/cloudera-datalake-api/)
- [Cloudera De API](https://apis.io/apis/cloudera/cloudera-de-api/)

## Tags

Df

---

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