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/.
Cloudera DataFlow Workload API is one of 24 APIs that Cloudera publishes on the 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.
This API exposes 71 operations across 71 paths, and defines 200 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.
71 operations
71 paths
200 schemas
71 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 71
Across 71 paths, the API surfaces 71 operations — 71 POST. Each is listed below with its method, path, parameters, and response codes.
CDFLocalRPCAPIVersion1 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-configurationdeprecated
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-versiondeprecated
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-versiondeprecated
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-flowdeprecated
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-flowdeprecated
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.
Schemas 200
The contract defines 200 schemas that model the data the API accepts and returns. The most detailed are RpcDeployment (43 properties), DeployedFlow (30 properties), RpcDeploymentConfiguration (29 properties), RpcDeployedFlow (28 properties). Each schema is shown below with its type and property counts.
AWSNodeStorageProfile
object
Custom AWS node storage parameters.
3 properties
AWSNodeStorageProfileMetaData
object
Custom AWS node storage limits.
4 properties
AbortAssetUpdateRequestRequest
object
Request object for aborting an asset update request
4 properties
3 required
AbortAssetUpdateRequestResponse
object
Response object for aborting an asset update request
AbortDeploymentRequestRequest
object
Request object for abort deployment request.
2 properties
2 required
AbortDeploymentRequestResponse
object
Response object for aborting a deployment request.
AbortFlowRequestInDeploymentRequest
object
Request object for abort flow deployment request.
2 properties
2 required
AbortFlowRequestInDeploymentResponse
object
Response object for aborting a flow deployment request.
AddFlowToDeploymentRequest
object
Request object to add a flow to an existing deployment.
13 properties
5 required
AddFlowToDeploymentResponse
object
Response object from creating a deployment.
1 property
AlertFrequencyTolerance
object
The alert frequency tolerance unit choices, including a default
2 properties
1 required
AlertFrequencyUnit
object
The alert frequency unit to use in KPI tolerances and metrics
3 properties
2 required
AssetReference
object
A reference to an asset used in a flow parameter
5 properties
AzureNodeStorageProfileMetaData
object
Azure node storage profile metadata.
4 properties
BasicClusterSize
object
Cluster scaling parameters.
3 properties
1 required
CancelChangeFlowVersionInDeploymentRequest
object
Request object for cancel change flow version of a flow deployment.
3 properties
3 required
CancelChangeFlowVersionInDeploymentResponse
object
Response object for cancel change flow version of a flow deployment.
1 property
CancelChangeFlowVersionRequest
object
Request object for cancel change flow version of a deployment.
2 properties
2 required
CancelChangeFlowVersionResponse
object
Response object for cancel change flow version of a deployment.
1 property
CancelNifiVersionUpdateRequest
object
Request object for cancelling a NiFi version update for a deployment.
2 properties
2 required
CancelNifiVersionUpdateResponse
object
Response object for cancelling a NiFi version update for a deployment.
1 property
ChangeFlowVersionInDeploymentRequest
object
Request object for change flow version of a flow deployment.
13 properties
3 required
ChangeFlowVersionInDeploymentResponse
object
Response object for change flow version of a flow deployment.
1 property
ChangeFlowVersionRequest
object
Request object for change flow version of a deployment.
11 properties
2 required
ChangeFlowVersionResponse
object
Response object for change flow version of a deployment.
1 property
ClusterSize
object
Cluster scaling parameters.
7 properties
1 required
ConfiguredAlert
object
An alert configuration that specifies a configured frequency with lower and/or upper thresholds
3 properties
ConfiguredAlertFrequencyTolerance
object
An alert configuration frequency tolerance for measuring an amount of time and unit for alert triggering
2 properties
2 required
ConfiguredAlertThreshold
object
A configured alert threshold to pair together a statistical unit and value
2 properties
2 required
ConfiguredKpi
object
An instantiated KPI specifying a metric on which to alert
5 properties
1 required
CreateAssetUpdateRequestRequest
object
Request object for creating an asset update request
3 properties
2 required
CreateAssetUpdateRequestResponse
object
Response object for creating an asset update request
1 property
CreateCustomNarConfigurationRequest
object
Request object for creating a custom NAR configuration.
6 properties
5 required
CreateCustomNarConfigurationResponse
object
Response for creating a custom NAR configuration.
6 properties
4 required
CreateCustomPythonConfigurationRequest
object
Request object for creating a custom Python configuration.
6 properties
5 required
CreateCustomPythonConfigurationResponse
object
Response for creating a custom Python configuration.
6 properties
4 required
CreateDeploymentRequest
object
Request object to create a deployment.
26 properties
4 required
CreateDeploymentResponse
object
Response object from creating a deployment.
1 property
CreateInboundConnectionEndpointRequest
object
Request object that contains FQDN for the Inbound Connection Endpoint to create
3 properties
1 required
CreateInboundConnectionEndpointResponse
object
Response object returned during Inbound Connection Endpoint creation
1 property
CreateParameterGroupRequest
object
Request object for creating a parameter group.
5 properties
2 required
CreateParameterGroupResponse
object
Response object for creating a parameter group.
1 property
CreateReportingTaskRequest
object
Request object for creating a reporting task
3 properties
2 required
CreateReportingTaskResponse
object
Response for creating a reporting task.
1 property
CustomClusterSizeLimits
object
Limits for the custom cluster size type.
4 properties
DeleteCustomNarConfigurationRequest
object
Request object for deleting a custom NAR configuration by CRN.
3 properties
3 required
DeleteCustomNarConfigurationResponse
object
Response object for deleting a custom NAR configuration.
6 properties
4 required
DeleteCustomPythonConfigurationRequest
object
Request object for deleting a custom Python configuration by CRN.
3 properties
3 required
DeleteCustomPythonConfigurationResponse
object
Response object for deleting a custom python configuration.
6 properties
4 required
DeleteFlowDraftRequest
object
Request object for deleting a flow designer draft.
2 properties
2 required
DeleteFlowDraftResponse
object
Response object for deleting a flow draft.
1 property
DeleteInboundConnectionEndpointRequest
object
Request object that contains the identifier of the Inbound Connection Endpoint to delete
2 properties
2 required
DeleteInboundConnectionEndpointResponse
object
Response object returned during deletion of an Inbound Connection Endpoint
DeleteParameterGroupRequest
object
Request object for deleting a parameter group.
2 properties
2 required
DeleteParameterGroupResponse
object
Response object for deleting a parameter group.
DeleteReportingTaskRequest
object
Request object for deleting a reporting task
3 properties
3 required
DeleteReportingTaskResponse
object
Response for deleting a reporting task.
1 property
DeployedFlow
object
A deployed flow on a NiFi cluster
30 properties
5 required
DeployedFlowMetadata
object
Contains metadata about a deployed flow.
2 properties
DeployedFlowStatus
object
The state and state message associated with a deployed flow.
3 properties
1 required
DeploymentStatus
object
The state and state message associated with a deployment.
3 properties
2 required
DescribeInboundConnectionEndpointRequest
object
Request object that contains the identifier of the Inbound Connection Endpoint to describe
2 properties
2 required
DescribeInboundConnectionEndpointResponse
object
Response object that describes an Inbound Connection Endpoint
1 property
DescribeParameterGroupRequest
object
Request object for describing a parameter group.
2 properties
2 required
DescribeParameterGroupResponse
object
Response object for describing a parameter group.
1 property
DfxEnvironmentStatus
object
Environment status.
3 properties
DfxLocalMeta
object
Metadata about the workload.
10 properties
5 required
DuplicateParameterGroupRequest
object
Request object for duplicating a parameter group.
4 properties
3 required
DuplicateParameterGroupResponse
object
Response object for duplicating a parameter group.
1 property
EnvCloudRegion
object
A cloud region
2 properties
Error
object
An object returned on an error.
2 properties
ExportDeploymentRequest
object
Request object to export deployment configuration.
3 properties
2 required
ExportDeploymentResponse
object
Response object for exporting a deployment.
1 property
FlowMetadata
object
Provides details about a flow designer draft.
11 properties
FlowParameter
object
A flow parameter
8 properties
FlowParameterGroup
object
A flow parameter group
4 properties
FlowSummary
object
Data object for information describing a flow designer draft.
13 properties
GetCustomNarConfigurationRequest
object
Request object for retrieving a custom NAR configuration by configuration CRN or deployment CRN.
3 properties
1 required
GetCustomNarConfigurationResponse
object
Response object for retrieving a custom NAR configuration by CRN.
6 properties
4 required
GetCustomPythonConfigurationRequest
object
Request object for retrieving a custom Python configuration by configuration CRN or deployment CRN.
3 properties
1 required
GetCustomPythonConfigurationResponse
object
Response object for retrieving a custom Python configuration by CRN.
6 properties
4 required
GetDefaultCustomNarConfigurationRequest
object
Request object for retrieving the default custom NAR configuration.
1 property
1 required
GetDefaultCustomNarConfigurationResponse
object
Response object for retrieving the default custom NAR configuration.
6 properties
4 required
GetDeploymentConfigurationMetadataRequest
object
Request object for retrieving deployment configuration metadata.
2 properties
2 required
GetDeploymentConfigurationMetadataResponse
object
Response object for retrieving deployment configuration metadata request.
1 property
GetDeploymentConfigurationRequest
object
Request object for retrieving deployment configuration.
2 properties
2 required
GetDeploymentConfigurationResponse
object
Response object for retrieving deployment configuration request.
1 property
GetDeploymentRequestDetailsRequest
object
Request object for retrieving deployment request details.
2 properties
2 required
GetDeploymentRequestDetailsResponse
object
Response object for retrieving deployment request details request.
1 property
GetFlowConfigurationInDeploymentRequest
object
Request object for retrieving a deployed flow configuration in a deployment.
3 properties
3 required
GetFlowConfigurationInDeploymentResponse
object
Response object for retrieving deployed flow configuration in a deployment.
1 property
GetFlowConfigurationMetadataInDeploymentRequest
object
Request object for retrieving a deployed flow configuration metadata in a deployment.
3 properties
3 required
GetFlowConfigurationMetadataInDeploymentResponse
object
Response object for retrieving deployed flow configuration metadata in a deployment.
1 property
GetFlowDeploymentRequestDetailsRequest
object
Request object for retrieving flow deployment request details.
2 properties
2 required
GetFlowRequestDetailsInDeploymentResponse
object
Response object for retrieving flow deployment request details request.
1 property
ImportDeploymentRequest
object
Request object to import deployment configuration.
4 properties
2 required
ImportDeploymentResponse
object
Response object for importing deployment configuration.
1 property
ImportFlowIntoDeploymentRequest
object
Request object to import a flow configuration into a deployment.
4 properties
4 required
ImportFlowIntoDeploymentResponse
object
Response object for importing a flow configuration into a deployment.
1 property
InboundConnectionEndpointCertificateSummary
object
Inbound Connection Endpoint Certificate Summary
4 properties
InboundConnectionEndpointClientCertificatesRequest
object
Request object to retrieve Inbound Connection Endpoint client's certificates.
2 properties
2 required
InboundConnectionEndpointClientCertificatesResponse
object
Response object that contains the client's certificates.
2 properties
InboundConnectionEndpointSummary
object
Inbound Connection Endpoint Summary
7 properties
KpiContextGroup
object
Captures the use of a KPI in the context of a process group
3 properties
2 required
KpiMetaData
object
A template for instantiating KPIs
3 properties
3 required
KpiScopeComponent
object
Provides scoping when defining KPIs
2 properties
2 required
KpiScopeMetaData
object
Provides scoping meta data for use during KPI creation
5 properties
3 required
KpiScopeMetricType
object
Provides the legal metric types for an owning scope
5 properties
4 required
KpiUnit
object
Captures the legal units for a metric, a means to avoid large numbers either before or after a decimal point
3 properties
3 required
ListDeploymentArchivesRequest
object
Request object to list exported archives of all deployments matching the search term.
2 properties
1 required
ListDeploymentArchivesResponse
object
Response for listing the deployment configuration backup archives.
1 property
ListFlowDraftsRequest
object
Request object for listing the flow designer drafts.
1 property
1 required
ListFlowDraftsResponse
object
Response object for listing the flow drafts.
1 property
ListInboundConnectionEndpointsRequest
object
Request object to use to list Inbound Connection Endpoints
1 property
1 required
ListInboundConnectionEndpointsResponse
object
Response object that contains a list of Inbound Connection Endpoints
1 property
ListNifiVersionsRequest
object
Request object for listing the supported NiFi versions.
1 property
1 required
ListNifiVersionsResponse
object
Response object for listing the supported NiFi versions.
1 property
ListParameterGroupsRequest
object
Request object for listing parameter groups.
3 properties
1 required
ListParameterGroupsResponse
object
Response object for listing parameter groups.
1 property
ListReportingTasksRequest
object
Request object for listing the reporting tasks for a deployment
2 properties
1 required
ListReportingTasksResponse
object
Response for listing the reporting tasks of a deployment.
1 property
ListTestSessionsRequest
object
Request object for listing the test sessions.
1 property
1 required
ListTestSessionsResponse
object
Response object for listing the test sessions.
1 property
ListenComponent
object
Provides subset of metadata of a Listen component
3 properties
1 required
MetricValue
object
A metric value.
2 properties
NodeStorage
object
Node storage parameters.
6 properties
NodeStorageProfileMetadata
object
Provides details about the node storage options.
10 properties
6 required
Parameter
object
Represents a parameter which can be used in a parameter context or a deployed flow.
6 properties
1 required
ParameterGroup
object
A parameter group represents a collection of parameters that can be used across multiple workloads.
13 properties
1 required
ParameterGroupSummary
object
Summary of a parameter group.
12 properties
1 required
ParameterGroupUsage
object
Represents a resource that uses a parameter group.
5 properties
2 required
ParameterRequest
object
Represents a parameter in a parameter group.
5 properties
1 required
ProjectMeta
object
The meta information about a project.
3 properties
ProjectSummary
object
Provides a summary of the project.
6 properties
ReassignResourcesRequest
object
Request object to reassign resources.
3 properties
2 required
ReassignResourcesResponse
object
Response object from reassigning resources.
RenewInboundConnectionEndpointCertificateRequest
object
Request object to renew Inbound Connection Endpoint certificate(s)
5 properties
2 required
RenewInboundConnectionEndpointCertificateResponse
object
Response object for Inbound Connection Endpoint certificate renewal request
ReportingTaskSummary
object
A reporting task summary
4 properties
RestartDeploymentRequest
object
Request object to restart a deployment.
3 properties
2 required
RestartDeploymentResponse
object
Response object for restarting a deployment request.
1 property
RestartTestSessionRequest
object
Request object for restarting a test session.
2 properties
2 required
RestartTestSessionResponse
object
Response object for restarting a flow designer runtime session.
1 property
ResumeDeploymentRequest
object
Request object to resume a deployment.
2 properties
2 required
ResumeDeploymentResponse
object
Response object for resuming a deployment.
1 property
RpcDeployedFlow
object
Provides details about a deployed flow.
28 properties
3 required
RpcDeployedFlowConfiguration
object
Provides all of the configuration that dictates how a flow is deployed.
9 properties
1 required
RpcDeployedFlowConfigurationMetadata
object
Provides details about the deployed flow and all of the different configuration items that are available.
8 properties
5 required
RpcDeployment
object
Provides details about a deployment.
43 properties
3 required
RpcDeploymentArchiveMetadata
object
Provides the metadata about deployment exported archive
9 properties
RpcDeploymentConfiguration
object
Provides all of the configuration that dictates how a flow should be deployed.
29 properties
1 required
RpcDeploymentConfigurationMetadata
object
Provides details about the deployment and all of the different configuration items that are available.
11 properties
6 required
RpcImportedDeploymentConfiguration
object
Contains the configuration data imported from exported archive.
18 properties
RpcWorkloadResourceSummary
object
Provides a summary of the workload resource.
2 properties
1 required
RuntimeSession
object
Provides details about a flow designer runtime session.
6 properties
ServiceMeta
object
The meta information about a DataFlow service.
5 properties
5 required
SimpleListenComponent
object
Provides subset of metadata of a Listen component.
2 properties
1 required
StartAllFlowsInDeploymentRequest
object
Request object for starting the NiFi flows in a deployment.
2 properties
2 required
StartAllFlowsInDeploymentResponse
object
Response object for starting all NiFi flows in a deployment.
1 property
StartFlowInDeploymentRequest
object
Request object for starting the NiFi flow.
3 properties
3 required
StartFlowInDeploymentResponse
object
Response object for starting the NiFi flow.
1 property
StartFlowRequest
object
Request object for starting the NiFi flow.
2 properties
2 required
StartFlowResponse
object
Response object for starting the NiFi flow.
1 property
StopAllFlowsInDeploymentRequest
object
Request object for stopping the NiFi flows in a deployment.
3 properties
2 required
StopAllFlowsInDeploymentResponse
object
Response object for stopping all NiFi flows in a deployment.
1 property
StopFlowInDeploymentRequest
object
Request object for stopping the NiFi flow.
4 properties
3 required
StopFlowInDeploymentResponse
object
Response object for stopping the NiFi flow.
1 property
StopFlowRequest
object
Request object for stopping the NiFi flow.
3 properties
2 required
StopFlowResponse
object
Response object for stopping the NiFi flow.
1 property
SuspendDeploymentRequest
object
Request object to suspend a deployment.
2 properties
2 required
SuspendDeploymentResponse
object
Response object for suspending a deployment.
1 property
SuspendTestSessionRequest
object
Request object for suspending a running test session.
2 properties
2 required
SuspendTestSessionResponse
object
Response object for suspending a flow designer runtime session.
1 property
TerminateDeploymentRequest
object
Request object to terminate a deployment.
2 properties
2 required
TerminateDeploymentResponse
object
Response object for terminating a deployment request.
1 property
TerminateFlowInDeploymentRequest
object
Request object to terminate a flow in a deployment.
3 properties
3 required
TerminateFlowInDeploymentResponse
object
Response object for terminating a flow in a deployment.
1 property
TerminateTestSessionRequest
object
Request object for terminating a test session.
2 properties
2 required
TerminateTestSessionResponse
object
Response object for terminating a flow designer test session.
1 property
UpdateCustomNarConfigurationRequest
object
Request object to update a custom NAR configuration.
7 properties
5 required
UpdateCustomNarConfigurationResponse
object
Response object for updating a custom NAR configuration.
6 properties
4 required
UpdateCustomPythonConfigurationRequest
object
Request object to update a custom Python configuration.
7 properties
6 required
UpdateCustomPythonConfigurationResponse
object
Response object for updating a custom Python configuration.
6 properties
4 required
UpdateDeploymentRequest
object
Provides all of the configuration that dictates how a deployment should be updated.
17 properties
3 required
UpdateDeploymentResponse
object
Response object from updating a deployment.
1 property
UpdateFlowInDeploymentRequest
object
Provides all of the configuration that dictates how a deployed flow should be updated.
8 properties
4 required
UpdateFlowInDeploymentResponse
object
Response object from updating a deployed flow.
1 property
UpdateNifiVersionRequest
object
Request object for updating the NiFi version of a deployment.
3 properties
3 required
UpdateNifiVersionResponse
object
Response object for updating the NiFi version of a deployment.
1 property
UpdateParameterGroupRequest
object
Request object for updating a parameter group. A parameter with only its name set indicates deletion. A parameter matching an existing name indicates an update…
4 properties
2 required
UpdateParameterGroupResponse
object
Response object for updating a parameter group.
1 property
UploadAssetRequest
object
Request object for uploading an asset
8 properties
4 required
UploadAssetResponse
object
Response for uploading an asset.
UploadParameterAssetRequest
object
Request object for uploading an asset to a parameter.
4 properties
4 required
UploadParameterAssetResponse
object
Response object for uploading a parameter asset.
ValidateCustomNarConfigurationRequest
object
Request object for validating a custom NAR configuration.
6 properties
5 required
ValidateCustomNarConfigurationResponse
object
Response object for validating custom NAR configuration.
ValidateCustomPythonConfigurationRequest
object
Request object for validating a custom Python configuration.
6 properties
5 required
ValidateCustomPythonConfigurationResponse
object
Response object for validating custom Python configuration.
VersionedParameterGroupReference
object
A reference to a specific version of a shared parameter group
2 properties
1 required
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 Control Plane Data Recovery API
Cloudera Data Warehouse API
Cloudera Environments API
#DataFlow#NiFi#Deployments
Where this information came from
This is an independent, third-party profile of Cloudera DataFlow Workload 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.