# Cloudera DataFlow Workload API

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

Operate running DataFlow deployments — start, stop, change flow version, manage custom NAR and Python configurations and parameter groups. 71 operations. The one service whose paths use /dfx/api/rpc-v1/ rather than /api/v1/.

## Operations (60 of 71)

| Method | Path | Summary |
|---|---|---|
| POST | `/dfx/api/rpc-v1/custom-nar-configurations/create-custom-nar-configuration` | Create the custom NAR configuration. |
| POST | `/dfx/api/rpc-v1/custom-nar-configurations/delete-custom-nar-configuration` | Deletes an orphaned custom NAR configuration. |
| POST | `/dfx/api/rpc-v1/custom-nar-configurations/get-custom-nar-configuration` | Get a custom NAR configuration. |
| POST | `/dfx/api/rpc-v1/custom-nar-configurations/get-default-custom-nar-configuration` | Get the default custom NAR configuration. Deprecated, no longer supported. |
| POST | `/dfx/api/rpc-v1/custom-nar-configurations/update-custom-nar-configuration` | Update the custom NAR configuration. |
| POST | `/dfx/api/rpc-v1/custom-nar-configurations/validate-custom-nar-configuration` | Validates the custom NAR configuration. |
| POST | `/dfx/api/rpc-v1/custom-python-configurations/create-custom-python-configuration` | Create the custom Python configuration. |
| POST | `/dfx/api/rpc-v1/custom-python-configurations/delete-custom-python-configuration` | Deletes an orphaned custom Python configuration. |
| POST | `/dfx/api/rpc-v1/custom-python-configurations/get-custom-python-configuration` | Get a custom Python configuration. |
| POST | `/dfx/api/rpc-v1/custom-python-configurations/update-custom-python-configuration` | Update the custom Python configuration. |
| POST | `/dfx/api/rpc-v1/custom-python-configurations/validate-custom-python-configuration` | Validates the custom Python configuration. |
| POST | `/dfx/api/rpc-v1/deployed-flows/abort-flow-request-in-deployment` | Aborts a flow request in deployment. |
| POST | `/dfx/api/rpc-v1/deployed-flows/add-flow-to-deployment` | Adds a flow to an existing deployment. |
| POST | `/dfx/api/rpc-v1/deployed-flows/cancel-change-flow-version-in-deployment` | Cancel change flow version for an existing flow deployment. |
| POST | `/dfx/api/rpc-v1/deployed-flows/change-flow-version-in-deployment` | Change flow version of a running deployed flow. |
| POST | `/dfx/api/rpc-v1/deployed-flows/get-flow-configuration-in-deployment` | Retrieves the deployed flow configuration in a deployment. |
| POST | `/dfx/api/rpc-v1/deployed-flows/get-flow-configuration-metadata-in-deployment` | Retrieves the deployed flow configuration metadata in a deployment. |
| POST | `/dfx/api/rpc-v1/deployed-flows/get-flow-request-details-in-deployment` | Retrieves flow request details and registers the flow deployment request. |
| POST | `/dfx/api/rpc-v1/deployed-flows/import-flow-into-deployment` | Import flow deployment configuration. |
| POST | `/dfx/api/rpc-v1/deployed-flows/start-flow-in-deployment` | Starts a flow in a deployment. |
| POST | `/dfx/api/rpc-v1/deployed-flows/stop-flow-in-deployment` | Stops a flow in a deployment. |
| POST | `/dfx/api/rpc-v1/deployed-flows/terminate-flow-in-deployment` | Terminates a flow in a deployment. |
| POST | `/dfx/api/rpc-v1/deployed-flows/update-flow-in-deployment` | Updates a flow deployment. |
| POST | `/dfx/api/rpc-v1/deployments/abort-asset-update-request` | Aborts asset update request. |
| POST | `/dfx/api/rpc-v1/deployments/abort-deployment-request` | Aborts a deployment request. |
| POST | `/dfx/api/rpc-v1/deployments/cancel-change-flow-version` | Cancel change flow version for an existing deployment. Deprecated, use cancel-change-flow-version-in-deployment. |
| POST | `/dfx/api/rpc-v1/deployments/cancel-nifi-version-update` | Cancels a NiFi version update for a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/change-flow-version` | Change flow version of a running deployment. Deprecated, use change-flow-version-in-deployment. |
| POST | `/dfx/api/rpc-v1/deployments/create-asset-update-request` | Create asset update request. |
| POST | `/dfx/api/rpc-v1/deployments/create-deployment` | Creates a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/create-reporting-task` | Creates a reporting task. |
| POST | `/dfx/api/rpc-v1/deployments/delete-reporting-task` | Deletes a reporting task. |
| POST | `/dfx/api/rpc-v1/deployments/export-deployment` | Export deployment configuration. |
| POST | `/dfx/api/rpc-v1/deployments/get-deployment-configuration` | Retrieves the deployment configuration. |
| POST | `/dfx/api/rpc-v1/deployments/get-deployment-configuration-metadata` | Retrieves the deployment configuration metadata. |
| POST | `/dfx/api/rpc-v1/deployments/get-deployment-request-details` | Retrieves deployment request details and registers the deployment request. |
| POST | `/dfx/api/rpc-v1/deployments/import-deployment` | Import deployment configuration. |
| POST | `/dfx/api/rpc-v1/deployments/list-deployment-archives` | Lists the exported archive metadata of all deployments. |
| POST | `/dfx/api/rpc-v1/deployments/list-reporting-tasks` | Lists all reporting tasks for a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/restart-deployment` | Restart a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/resume-deployment` | Resumes a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/start-all-flows-in-deployment` | Starts all flows in a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/start-flow` | Starts a flow. Deprecated, use start-flow-in-deployment. |
| POST | `/dfx/api/rpc-v1/deployments/stop-all-flows-in-deployment` | Stops all flows in a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/stop-flow` | Stops a flow. Deprecated, use stop-flow-in-deployment. |
| POST | `/dfx/api/rpc-v1/deployments/suspend-deployment` | Suspends a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/terminate-deployment` | Terminates a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/update-deployment` | Updates a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/update-nifi-version` | Updates the NiFi version of a deployment. |
| POST | `/dfx/api/rpc-v1/deployments/upload-asset` | Upload an asset. |
| POST | `/dfx/api/rpc-v1/environments/list-nifi-versions` | Lists all supported NiFi versions. |
| POST | `/dfx/api/rpc-v1/fd-proxy/delete-flow-draft` | Deletes flow draft. |
| POST | `/dfx/api/rpc-v1/fd-proxy/list-flow-drafts` | Lists flow drafts. |
| POST | `/dfx/api/rpc-v1/fd-proxy/list-test-sessions` | Lists test sessions. |
| POST | `/dfx/api/rpc-v1/fd-proxy/restart-test-session` | Restarts test session. |
| POST | `/dfx/api/rpc-v1/fd-proxy/suspend-test-session` | Suspends test session. |
| POST | `/dfx/api/rpc-v1/fd-proxy/terminate-test-session` | Terminates test session. |
| POST | `/dfx/api/rpc-v1/inbound-connection-endpoint-certificates/download-client-certificates-encoded` | Get Inbound Connection Endpoint Client Certificates (in PEM encoding) |
| POST | `/dfx/api/rpc-v1/inbound-connection-endpoints/create-inbound-connection-endpoint` | Create Inbound Connection Endpoint |
| POST | `/dfx/api/rpc-v1/inbound-connection-endpoints/delete-inbound-connection-endpoint` | Delete Inbound Connection Endpoint |

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

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-dfworkload-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/overlays/cloudera-dfworkload-overlay.yaml
- **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 Audit Service API](https://apis.io/apis/cloudera/cloudera-audit-api/)
- [Cloudera Private Links API](https://apis.io/apis/cloudera/cloudera-cloudprivatelinks-api/)
- [Cloudera Compute Service API](https://apis.io/apis/cloudera/cloudera-compute-api/)
- [Cloudera Consumption API](https://apis.io/apis/cloudera/cloudera-consumption-api/)
- [Cloudera Data Catalog API](https://apis.io/apis/cloudera/cloudera-datacatalog-api/)
- [Cloudera Data Hub API](https://apis.io/apis/cloudera/cloudera-datahub-api/)
- [Cloudera Datalake API](https://apis.io/apis/cloudera/cloudera-datalake-api/)
- [Cloudera Data Engineering API](https://apis.io/apis/cloudera/cloudera-dataengineering-api/)
- [Cloudera DataFlow API](https://apis.io/apis/cloudera/cloudera-dataflow-api/)
- [Cloudera Control Plane Data Recovery API](https://apis.io/apis/cloudera/cloudera-datarecovery-api/)
- [Cloudera Data Warehouse API](https://apis.io/apis/cloudera/cloudera-datawarehouse-api/)
- [Cloudera Environments API](https://apis.io/apis/cloudera/cloudera-environments-api/)

## Tags

DataFlow, NiFi, Deployments

---

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