Cloudera

Cloudera DataFlow Workload API

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/.

GitHub OpenAPI

Operations 71

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 #
POST /dfx/api/rpc-v1/inbound-connection-endpoints/describe-inbound-connection-endpoint Describe Inbound Connection Endpoint #
POST /dfx/api/rpc-v1/inbound-connection-endpoints/list-inbound-connection-endpoints List Inbound Connection Endpoints #
POST /dfx/api/rpc-v1/inbound-connection-endpoints/renew-certificates Renew Inbound Connection Endpoint certificates #
POST /dfx/api/rpc-v1/parameter-groups/create-parameter-group Creates a new parameter group. #
POST /dfx/api/rpc-v1/parameter-groups/delete-parameter-group Deletes the parameter group. #
POST /dfx/api/rpc-v1/parameter-groups/describe-parameter-group Describes the parameter group with the given parameter group CRN. #
POST /dfx/api/rpc-v1/parameter-groups/duplicate-parameter-group Duplicates the parameter group with the given CRN under the given new name. #
POST /dfx/api/rpc-v1/parameter-groups/list-parameter-groups Lists all known parameter groups. #
POST /dfx/api/rpc-v1/parameter-groups/update-parameter-group Updates the parameter group for the given parameter group CRN. #
POST /dfx/api/rpc-v1/parameter-groups/upload-parameter-asset Uploads a parameter asset. #
POST /dfx/api/rpc-v1/workload-resources/reassign-resources Modifies the project assignment of the given workload resources. #

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-dfworkload-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/overlays/cloudera-dfworkload-overlay.yaml

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-dataflow-workload-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-dfworkload-openapi.yml Raw ↑ 
x-generated: Automatically generated by protocols script. Do not edit manually.
swagger: '2.0'
x-endpoint-name: dfworkload
x-products: CDP
x-form-factors: public
x-cdp-releases: PUBLIC
info:
  description: "This REST API provides remote access to the DataFlow Service.\n Endpoints that are marked as [BETA] are subject to change in future releases of the application without backwards compatibility and without a major version change."
  version: 0.9.163
  title: Cloudera DataFlow Workload Service
  license:
    name: Apache 2.0
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
tags:
  - name: CDFLocalRPCAPIVersion1
paths:
  /dfx/api/rpc-v1/custom-nar-configurations/create-custom-nar-configuration:
    post:
      summary: Create the custom NAR configuration.
      description: Create the custom NAR configuration.
      operationId: createCustomNarConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Create Custom NAR Configuration Request
          required: true
          schema:
            $ref: '#/definitions/CreateCustomNarConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateCustomNarConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/custom-nar-configurations/delete-custom-nar-configuration:
    post:
      summary: Deletes an orphaned custom NAR configuration.
      description: Deletes an orphaned custom NAR configuration.
      operationId: deleteCustomNarConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Delete Custom NAR Configuration Request
          required: true
          schema:
            $ref: '#/definitions/DeleteCustomNarConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteCustomNarConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/custom-nar-configurations/get-custom-nar-configuration:
    post:
      summary: Get a custom NAR configuration.
      description: Get a custom NAR configuration.
      operationId: getCustomNarConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Get Custom NAR Configuration Request
          required: true
          schema:
            $ref: '#/definitions/GetCustomNarConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetCustomNarConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/custom-nar-configurations/get-default-custom-nar-configuration:
    post:
      summary: Get the default custom NAR configuration. Deprecated, no longer supported.
      description: Get the default custom NAR configuration. Deprecated, no longer supported.
      operationId: getDefaultCustomNarConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Get Default Custom NAR Configuration Request
          required: true
          schema:
            $ref: '#/definitions/GetDefaultCustomNarConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetDefaultCustomNarConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      deprecated: true
      x-deprecated: true
  /dfx/api/rpc-v1/custom-nar-configurations/update-custom-nar-configuration:
    post:
      summary: Update the custom NAR configuration.
      description: Update the custom NAR configuration.
      operationId: updateCustomNarConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Update Custom NAR Configuration Request
          required: true
          schema:
            $ref: '#/definitions/UpdateCustomNarConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateCustomNarConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/custom-nar-configurations/validate-custom-nar-configuration:
    post:
      summary: Validates the custom NAR configuration.
      description: Validates the custom NAR configuration.
      operationId: validateCustomNarConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Validate Custom NAR Configuration Request
          required: true
          schema:
            $ref: '#/definitions/ValidateCustomNarConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ValidateCustomNarConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/custom-python-configurations/create-custom-python-configuration:
    post:
      summary: Create the custom Python configuration.
      description: Create the custom Python configuration.
      operationId: createCustomPythonConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Create Custom Python Configuration Request
          required: true
          schema:
            $ref: '#/definitions/CreateCustomPythonConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateCustomPythonConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/custom-python-configurations/delete-custom-python-configuration:
    post:
      summary: Deletes an orphaned custom Python configuration.
      description: Deletes an orphaned custom Python configuration.
      operationId: deleteCustomPythonConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Delete Custom Python Configuration Request
          required: true
          schema:
            $ref: '#/definitions/DeleteCustomPythonConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteCustomPythonConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/custom-python-configurations/get-custom-python-configuration:
    post:
      summary: Get a custom Python configuration.
      description: Get a custom Python configuration.
      operationId: getCustomPythonConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Get Custom Python Configuration Request
          required: true
          schema:
            $ref: '#/definitions/GetCustomPythonConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetCustomPythonConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/custom-python-configurations/update-custom-python-configuration:
    post:
      summary: Update the custom Python configuration.
      description: Update the custom Python configuration.
      operationId: updateCustomPythonConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Update Custom Python Configuration Request
          required: true
          schema:
            $ref: '#/definitions/UpdateCustomPythonConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateCustomPythonConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/custom-python-configurations/validate-custom-python-configuration:
    post:
      summary: Validates the custom Python configuration.
      description: Validates the custom Python configuration.
      operationId: validateCustomPythonConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Validate Custom Python Configuration Request
          required: true
          schema:
            $ref: '#/definitions/ValidateCustomPythonConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ValidateCustomPythonConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/abort-flow-request-in-deployment:
    post:
      summary: Aborts a flow request in deployment.
      description: Aborts a flow request in a deployment.
      operationId: abortFlowRequestInDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Abort Flow Request In Deployment
          required: true
          schema:
            $ref: '#/definitions/AbortFlowRequestInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/AbortFlowRequestInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/add-flow-to-deployment:
    post:
      summary: Adds a flow to an existing deployment.
      description: Adds a flow to an existing deployment.
      operationId: addFlowToDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Add Flow to Deployment Request
          required: true
          schema:
            $ref: '#/definitions/AddFlowToDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/AddFlowToDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/cancel-change-flow-version-in-deployment:
    post:
      summary: Cancel change flow version for an existing flow deployment.
      description: Cancel change flow version for an existing flow deployment.
      operationId: cancelChangeFlowVersionInDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Cancel Change Flow Version In Deployment Request
          required: true
          schema:
            $ref: '#/definitions/CancelChangeFlowVersionInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CancelChangeFlowVersionInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/change-flow-version-in-deployment:
    post:
      summary: Change flow version of a running deployed flow.
      description: Change flow version of a running deployed flow.
      operationId: changeFlowVersionInDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Change Flow Version In Deployment Request
          required: true
          schema:
            $ref: '#/definitions/ChangeFlowVersionInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ChangeFlowVersionInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/get-flow-configuration-in-deployment:
    post:
      summary: Retrieves the deployed flow configuration in a deployment.
      description: Retrieves the deployed flow configuration in a deployment.
      operationId: getFlowConfigurationInDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Get Flow Configuration In Deployment Request
          required: true
          schema:
            $ref: '#/definitions/GetFlowConfigurationInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetFlowConfigurationInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/get-flow-configuration-metadata-in-deployment:
    post:
      summary: Retrieves the deployed flow configuration metadata in a deployment.
      description: Retrieves the deployed flow configuration metadata in a deployment.
      operationId: getFlowConfigurationMetadataInDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Get Flow Configuration Metadata In Deployment Request
          required: true
          schema:
            $ref: '#/definitions/GetFlowConfigurationMetadataInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetFlowConfigurationMetadataInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/get-flow-request-details-in-deployment:
    post:
      summary: Retrieves flow request details and registers the flow deployment request.
      description: Retrieves flow request details and registers the flow deployment request.
      operationId: getFlowRequestDetailsInDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Get Flow Request Details in Deployment
          required: true
          schema:
            $ref: '#/definitions/GetFlowDeploymentRequestDetailsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetFlowRequestDetailsInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/import-flow-into-deployment:
    post:
      summary: Import flow deployment configuration.
      description: Imports flow configuration into a deployment from archive with provided archive name.
      operationId: importFlowIntoDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Import Flow Into Deployment Request
          required: true
          schema:
            $ref: '#/definitions/ImportFlowIntoDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ImportFlowIntoDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/start-flow-in-deployment:
    post:
      summary: Starts a flow in a deployment.
      description: Starts a NiFi flow in a deployment.
      operationId: startFlowInDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Start Flow In Deployment Request
          required: true
          schema:
            $ref: '#/definitions/StartFlowInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/StartFlowInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/stop-flow-in-deployment:
    post:
      summary: Stops a flow in a deployment.
      description: Stops a NiFi flow in a deployment.
      operationId: stopFlowInDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Stop Flow In Deployment Request
          required: true
          schema:
            $ref: '#/definitions/StopFlowInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/StopFlowInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/terminate-flow-in-deployment:
    post:
      summary: Terminates a flow in a deployment.
      description: Initiates the termination of a flow in a deployment.
      operationId: terminateFlowInDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Terminate Flow In Deployment Request
          required: true
          schema:
            $ref: '#/definitions/TerminateFlowInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/TerminateFlowInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployed-flows/update-flow-in-deployment:
    post:
      summary: Updates a flow deployment.
      description: Updates a flow deployment.
      operationId: updateFlowInDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload,df
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Update Flow In Deployment Request
          required: true
          schema:
            $ref: '#/definitions/UpdateFlowInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateFlowInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/abort-asset-update-request:
    post:
      summary: Aborts asset update request.
      description: Aborts an asset update request for a given deployment.
      operationId: abortAssetUpdateRequest
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Abort Asset Update Request
          required: true
          schema:
            $ref: '#/definitions/AbortAssetUpdateRequestRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/AbortAssetUpdateRequestResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/abort-deployment-request:
    post:
      summary: Aborts a deployment request.
      description: Aborts a deployment request.
      operationId: abortDeploymentRequest
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Abort Deployment Request
          required: true
          schema:
            $ref: '#/definitions/AbortDeploymentRequestRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/AbortDeploymentRequestResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/cancel-change-flow-version:
    post:
      summary: Cancel change flow version for an existing deployment. Deprecated, use cancel-change-flow-version-in-deployment.
      description: Cancel change flow version for an existing deployment.
      operationId: cancelChangeFlowVersion
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Cancel Change Flow Version Request
          required: true
          schema:
            $ref: '#/definitions/CancelChangeFlowVersionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CancelChangeFlowVersionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      deprecated: true
  /dfx/api/rpc-v1/deployments/cancel-nifi-version-update:
    post:
      summary: Cancels a NiFi version update for a deployment.
      description: Cancels a NiFi version update for a deployment.
      operationId: cancelNifiVersionUpdate
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Cancel NiFi Version Update
          required: true
          schema:
            $ref: '#/definitions/CancelNifiVersionUpdateRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CancelNifiVersionUpdateResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/change-flow-version:
    post:
      summary: Change flow version of a running deployment. Deprecated, use change-flow-version-in-deployment.
      description: Change flow version of a running deployment.
      operationId: changeFlowVersion
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Change Flow Version Request
          required: true
          schema:
            $ref: '#/definitions/ChangeFlowVersionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ChangeFlowVersionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      deprecated: true
  /dfx/api/rpc-v1/deployments/create-asset-update-request:
    post:
      summary: Create asset update request.
      description: Create an update request for modifying the assets of a given deployment.
      operationId: createAssetUpdateRequest
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Create Asset Update Request
          required: true
          schema:
            $ref: '#/definitions/CreateAssetUpdateRequestRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateAssetUpdateRequestResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/create-deployment:
    post:
      summary: Creates a deployment.
      description: Creates a deployment.
      operationId: createDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Create Deployment Request
          required: true
          schema:
            $ref: '#/definitions/CreateDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/create-reporting-task:
    post:
      summary: Creates a reporting task.
      description: Creates a reporting task in a deployment.
      operationId: createReportingTask
      x-workload: true
      x-client-only: true
      x-extensions: workload,df
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Create Reporting Task
          required: true
          schema:
            $ref: '#/definitions/CreateReportingTaskRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateReportingTaskResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/delete-reporting-task:
    post:
      summary: Deletes a reporting task.
      description: Deletes a reporting task from a deployment.
      operationId: deleteReportingTask
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Delete Reporting Task
          required: true
          schema:
            $ref: '#/definitions/DeleteReportingTaskRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteReportingTaskResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/export-deployment:
    post:
      summary: Export deployment configuration.
      description: Exports deployment configuration.
      operationId: exportDeployment
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Export Deployment Request
          required: true
          schema:
            $ref: '#/definitions/ExportDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ExportDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/get-deployment-configuration:
    post:
      summary: Retrieves the deployment configuration.
      description: Retrieves the deployment configuration.
      operationId: getDeploymentConfiguration
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Get Deployment Configuration Request
          required: true
          schema:
            $ref: '#/definitions/GetDeploymentConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetDeploymentConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/get-deployment-configuration-metadata:
    post:
      summary: Retrieves the deployment configuration metadata.
      description: Retrieves the deployment configuration metadata.
      operationId: getDeploymentConfigurationMetadata
      x-workload: true
      x-client-only: true
      x-extensions: workload
      tags:
        - CDFLocalRPCAPIVersion1
      parameters:
        - in: body
          name: input
          description: Get Deployment Configuration Metadata Request
          required: true
          schema:
            $ref: '#/definitions/GetDeploymentConfigurationMetadataRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetDeploymentConfigurationMetadataResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /dfx/api/rpc-v1/deployments/get-deplo

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