Cloudera Df API
The Df API from Cloudera — 66 operation(s) for df.
Operations 66
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Can I add a prebuilt ReadyFlow from the gallery into my DataFlow account?”
“What do I need to add a ReadyFlow so my team can deploy it?”
Tell an agent
Add ReadyFlow {readyflowCrn} to my account.
Make the gallery ReadyFlow {readyflowCrn} available in our DataFlow account.
POST
/api/v1/df/assignToCollection
Assign a flow definition to a collection · Assign a flow definition to collection
#
Ask an LLM
“Can I group an existing flow definition into a catalog collection?”
“Which call puts a flow definition I already imported into a collection?”
Tell an agent
Assign flow {flowCrn} to collection {catalogCollectionCrn}.
Move flow definition {flowCrn} into the {catalogCollectionCrn} catalog collection.
POST
/api/v1/df/cancelDeleteProject
Cancel a pending project deletion · Cancels deletion of a Project
#
Ask an LLM
“Can I stop a DataFlow project from being deleted after I requested it?”
“What revision do I need to cancel a project's deletion?”
Tell an agent
Cancel the deletion of project {projectCrn} at revision {projectRevision}.
Stop deleting project {projectCrn}, revision {projectRevision}.
Ask an LLM
“How do I create a new collection in the DataFlow catalog?”
“Can I add a description when creating a catalog collection?”
Tell an agent
Create a catalog collection named {name}.
Create collection {name} described as {description}.
Ask an LLM
“Can I label a specific flow version with a colored tag?”
“Is there a way to mark one flow definition version with a named tag?”
Tell an agent
Tag flow version {flowVersionCrn} as {tagName}.
Add a {tagColor} tag {tagName} to flow version {flowVersionCrn}.
Ask an LLM
“How do I create a project inside a DataFlow service?”
“Which service does a new DataFlow project need to belong to?”
Tell an agent
Create project {name} in service {serviceCrn}.
Create a project called {name} on service {serviceCrn} with description {description}.
POST
/api/v1/df/deleteAddedReadyflow
Remove an added ReadyFlow from my account · Delete added ready flow
#
Ask an LLM
“Can I remove a ReadyFlow I previously added to my account?”
“Is there a way to undo adding a ReadyFlow to our DataFlow account?”
Tell an agent destructive · confirm first
Delete added ReadyFlow {addedReadyflowCrn}.
Remove the ReadyFlow {addedReadyflowCrn} we added from our account.
Ask an LLM
“Can I delete a catalog collection that still has flows in it?”
“What's the way to get rid of an empty DataFlow catalog collection?”
Tell an agent destructive · confirm first
Delete catalog collection {catalogCollectionCrn}.
Remove the empty collection {catalogCollectionCrn} from the catalog.
Ask an LLM
“How do I delete a flow definition from the DataFlow catalog?”
“Can I permanently remove a flow from the catalog?”
Tell an agent destructive · confirm first
Delete flow {flowCrn}.
Remove flow definition {flowCrn} from the catalog.
Ask an LLM
“Can I remove a tag I put on a flow version?”
“What do I need to untag a flow definition version?”
Tell an agent destructive · confirm first
Remove tag {tagName} from flow version {flowVersionCrn}.
Delete the {tagName} tag on flow version {flowVersionCrn}.
Ask an LLM
“Can I delete a DataFlow project I no longer use?”
“Does deleting a DataFlow project require its current revision number?”
Tell an agent destructive · confirm first
Delete project {projectCrn} at revision {projectRevision}.
Remove DataFlow project {projectCrn} (revision {projectRevision}).
POST
/api/v1/df/describeAddedReadyflow
Get details of a ReadyFlow I added · Describe added ready flow detail
#
Ask an LLM
“Can I see the details of a ReadyFlow as it was added to my account?”
“What does our added copy of a ReadyFlow contain?”
Tell an agent
Show details for added ReadyFlow {addedReadyflowCrn}.
Describe the ReadyFlow {addedReadyflowCrn} in our account.
POST
/api/v1/df/describeCollection
Get a catalog collection's details · Describe catalog collection
#
Ask an LLM
“What's in a specific DataFlow catalog collection?”
“Can I look up one catalog collection by its CRN?”
Tell an agent
Describe catalog collection {catalogCollectionCrn}.
Show me the details of collection {catalogCollectionCrn}.
Ask an LLM
“What's the current state of one of my DataFlow deployments?”
“Can I see the configuration of a single deployment?”
Tell an agent
Describe deployment {deploymentCrn}.
Show me deployment {deploymentCrn}'s details.
POST
/api/v1/df/describeDeploymentEventDetail
Get details of a deployment event · Describe event detail for deployment
#
Ask an LLM
“Can I see the full details of one event from a deployment's history?”
“What extra detail is recorded for a specific deployment event?”
Tell an agent
Show event {eventCrn} for deployment {deploymentCrn}.
Get detail on deployment event {eventCrn} in {deploymentCrn}.
Ask an LLM
“What details does the catalog hold for one flow definition?”
“Can I look up a flow definition by its CRN?”
Tell an agent
Describe flow {flowCrn}.
Show catalog details for flow definition {flowCrn}.
POST
/api/v1/df/describeFlowEventDetailInDeployment
Get detail of a deployed flow's event · Describe flow event detail in a deployment
#
Ask an LLM
“Can I drill into one event for a specific flow running in a deployment?”
“What detail is available for a flow-level event in a deployment?”
Tell an agent
Show event {eventCrn} for flow {deployedFlowCrn} in deployment {deploymentCrn}.
Get detail on flow event {eventCrn} of deployed flow {deployedFlowCrn} in {deploymentCrn}.
POST
/api/v1/df/describeFlowInDeployment
Describe a flow running in a deployment · Describe flow in a deployment
#
Ask an LLM
“What does a single deployed flow look like inside a deployment?”
“Can I check the configuration of one flow in a multi-flow deployment?”
Tell an agent
Describe flow {deployedFlowCrn} in deployment {deploymentCrn}.
Show me deployed flow {deployedFlowCrn} within {deploymentCrn}.
Ask an LLM
“What are the details of one DataFlow project?”
“Can I look up a single project by its CRN?”
Tell an agent
Describe project {projectCrn}.
Show details for DataFlow project {projectCrn}.
POST
/api/v1/df/describeReadyflow
Get a ReadyFlow's details from the gallery · Describe ready flow
#
Ask an LLM
“What does a ReadyFlow in the gallery do before I add it?”
“Can I see the details of a ReadyFlow I haven't added yet?”
Tell an agent
Describe ReadyFlow {readyflowCrn}.
Show gallery details for ReadyFlow {readyflowCrn}.
Ask an LLM
“What's the status of the DataFlow service in my environment?”
“Can I see how a DataFlow service is configured?”
Tell an agent
Describe DataFlow service {serviceCrn}.
Show me the details of service {serviceCrn}.
POST
/api/v1/df/describeServiceEventDetail
Get details of a service event · Describe event history detail for service
#
Ask an LLM
“Can I see the full detail of one event in a DataFlow service's history?”
“What extra information is recorded for a service-level event?”
Tell an agent
Show event {eventCrn} for service {serviceCrn}.
Get detail on service event {eventCrn} in {serviceCrn}.
Ask an LLM
“How do I disable DataFlow in an environment?”
“Can I terminate running deployments when disabling the service?”
Tell an agent destructive · confirm first
Disable DataFlow service {serviceCrn}.
Disable service {serviceCrn} with terminate deployments set to {terminateDeployments}.
POST
/api/v1/df/enableService
Enable DataFlow in a CDP environment · Enable DataFlow service from a CDP environment
#
Ask an LLM
“How do I turn on DataFlow for a CDP environment?”
“Can I set the minimum and maximum Kubernetes node counts when enabling DataFlow?”
Tell an agent
Enable DataFlow in environment {environmentCrn} with {minK8sNodeCount} to {maxK8sNodeCount} nodes, public load balancer {usePublicLoadBalancer}.
Enable DataFlow on {environmentCrn} as a private cluster {privateCluster}, nodes {minK8sNodeCount}-{maxK8sNodeCount}, public LB {usePublicLoadBalancer}.
Ask an LLM
“Can I download the flow definition for a specific version?”
“Where do I get the exported flow definition for a flow version?”
Tell an agent
Download flow version {flowVersionCrn}.
Export the flow definition for version {flowVersionCrn}.
Ask an LLM
“Can I get kubectl access config for my DataFlow service cluster?”
“Where do I download the Kubernetes config for a DataFlow environment?”
Tell an agent
Get the kubeconfig for DataFlow service {serviceCrn}.
Download kubeconfig for service {serviceCrn}.
POST
/api/v1/df/grantUserKubernetesAccess
Grant a user access to the DataFlow cluster · Grant remote user access to the service's cluster
#
Ask an LLM
“How do I give a cloud user access to the Kubernetes cluster behind DataFlow?”
“Can I grant a remote user access to a DataFlow service's cluster?”
Tell an agent
Grant cloud user {cloudUserId} access to the cluster of service {serviceCrn}.
Give {cloudUserId} Kubernetes access on DataFlow service {serviceCrn}.
Ask an LLM
“How do I import a flow definition file as a new flow in the catalog?”
“Can I place a newly imported flow definition straight into a collection?”
Tell an agent
Import {file} as a new flow named {name}.
Import flow definition {file} named {name} into collection {collectionCrn}.
POST
/api/v1/df/importFlowDefinitionVersion
Import a new version of an existing flow · Import a new flow definition version to an existing flow
#
Ask an LLM
“Can I upload a new version of a flow that's already in the catalog?”
“Is it possible to add version comments when importing an updated flow definition?”
Tell an agent
Import {file} as a new version of flow {flowCrn}.
Add a new version to flow {flowCrn} from {file} with comments {comments}.
POST
/api/v1/df/initiateDeployment
Start creating a deployment (internal) · Initiate a deployment creation
#
Ask an LLM
“What is the internal call that starts creating a deployment from a flow version?”
“Can I kick off a deployment creation for a flow version on a service directly?”
Tell an agent
Initiate a deployment of flow version {flowVersionCrn} on service {serviceCrn}.
Start internal deployment creation for {flowVersionCrn} on {serviceCrn}.
POST
/api/v1/df/initiateFlowInDeployment
Start adding a flow to a deployment (internal) · Initiate the flow creation process in a deployment
#
Ask an LLM
“Can I begin adding another flow version to an existing deployment?”
“What internal call starts creating a flow inside a deployment?”
Tell an agent
Initiate flow {flowVersionCrn} in deployment {deploymentCrn} on service {serviceCrn}.
Start adding flow version {flowVersionCrn} to deployment {deploymentCrn} on {serviceCrn}.
Ask an LLM
“What collections exist in my DataFlow catalog?”
“Can I search catalog collections by name?”
Tell an agent
List my catalog collections.
Find catalog collections matching {searchTerm}.
POST
/api/v1/df/listDeployableServicesForNewDeployments
List services I can deploy flows to · List services that a DataFlow Admin can deploy to
#
Ask an LLM
“Which DataFlow services am I allowed to deploy a new flow to?”
“Where can a DataFlow Admin create new deployments?”
Tell an agent
List services available for new deployments.
Show the services I can deploy to as a DataFlow Admin.
POST
/api/v1/df/listDeploymentActiveAlerts
List active alerts for a deployment · List active alerts for deployment
#
Ask an LLM
“Are there any active alerts on my deployment right now?”
“Can I sort a deployment's active alerts?”
Tell an agent
List active alerts for deployment {deploymentCrn}.
Show current alerts on {deploymentCrn} sorted by {sort}.
POST
/api/v1/df/listDeploymentEvents
List a deployment's event history · List event history for deployment
#
Ask an LLM
“What happened to my deployment recently?”
“Can I filter a deployment's event history from a certain timestamp?”
Tell an agent
List events for deployment {deploymentCrn}.
Show event history for {deploymentCrn} since {timestampFrom}.
Ask an LLM
“What KPIs is my deployment hitting over the last period?”
“Can I choose the time period for deployment KPI metrics?”
Tell an agent
List KPIs for deployment {deploymentCrn} over {metricsTimePeriod}.
Show KPI metrics of {deploymentCrn} for {metricsTimePeriod}.
POST
/api/v1/df/listDeploymentSystemMetrics
Get system metrics for a deployment · List deployment System metrics
#
Ask an LLM
“What system-level metrics does a deployment report over time?”
“Can I see a deployment's system metrics for a chosen time window?”
Tell an agent
Get system metrics for deployment {deploymentCrn} over {metricsTimePeriod}.
Show {deploymentCrn} system resource metrics for {metricsTimePeriod}.
Ask an LLM
“Which flow deployments are running across my DataFlow services?”
“Can I search or filter my deployments?”
Tell an agent
List my deployments.
Find deployments matching {searchTerm}.
Ask an LLM
“What diagnostic bundles have been requested for my DataFlow service?”
“Can I check the status of a diagnostics collection by its UUID?”
Tell an agent
List diagnostics requests for service {dfServiceCrn}.
Show diagnostics {uuids} for service {dfServiceCrn}.
Ask an LLM
“What values are available for a given filter type in DataFlow listings?”
“Can I fetch the allowed values for a filter type before filtering a list?”
Tell an agent
List filter options for filter type {filterType}.
Show the values available for the {filterType} filter.
POST
/api/v1/df/listFlowActiveAlertsInDeployment
List active alerts for a deployed flow · List active alerts for a flow in a deployment
#
Ask an LLM
“Does a specific flow in my deployment have any active alerts?”
“Can I see alerts for just one flow rather than the whole deployment?”
Tell an agent
List active alerts for flow {deployedFlowCrn} in deployment {deploymentCrn}.
Show current alerts on deployed flow {deployedFlowCrn} of {deploymentCrn}.
POST
/api/v1/df/listFlowDefinitionVersions
List versions of a flow definition · List flow definition versions
#
Ask an LLM
“What versions exist for a flow definition?”
“Can I search a flow's versions by a term?”
Tell an agent
List versions of flow {flowCrn}.
Find versions of flow {flowCrn} matching {searchTerm}.
Ask an LLM
“What flow definitions are in my DataFlow catalog?”
“Can I list only the flow definitions within one collection?”
Tell an agent
List flow definitions.
List flow definitions in collection {collectionCrn}.
POST
/api/v1/df/listFlowEventsInDeployment
List event history for a deployed flow · List event history for a flow in a deployment
#
Ask an LLM
“What events has one flow in my deployment logged?”
“Can I filter a deployed flow's events since a timestamp?”
Tell an agent
List events for flow {deployedFlowCrn} in deployment {deploymentCrn}.
Show events of deployed flow {deployedFlowCrn} in {deploymentCrn} since {timestampFrom}.
POST
/api/v1/df/listFlowKpisInDeployment
Get KPI metrics for a deployed flow · List KPI metrics for a flow in a deployment
#
Ask an LLM
“How is a single flow performing within its deployment?”
“Can I chart KPIs for one deployed flow over a time period?”
Tell an agent
Get KPIs for flow {deployedFlowCrn} in deployment {deploymentCrn} over {metricsTimePeriod}.
Show KPI charts for deployed flow {deployedFlowCrn} in {deploymentCrn} for {metricsTimePeriod}.
Ask an LLM
“What tags are attached to a flow version?”
“Can I check whether a flow version has been tagged?”
Tell an agent
List tags on flow version {flowVersionCrn}.
Show the tags for {flowVersionCrn}.
Ask an LLM
“Which flows are running inside a particular deployment?”
“Can I search the flows within one deployment?”
Tell an agent
List flows in deployment {deploymentCrn}.
Find flows in {deploymentCrn} matching {searchTerm}.
Ask an LLM
“What DataFlow notifications have arrived since a given time?”
“Can I fetch only notifications newer than a timestamp?”
Tell an agent
List notifications since {timestampAfter}.
Show DataFlow notifications after {timestampAfter}.
Ask an LLM
“Which filter values can I use when listing projects?”
“Can I get the allowed project filter values for a filter type?”
Tell an agent
List project filter options for {filterType}.
Show values I can use for the {filterType} project filter.
Ask an LLM
“What projects exist across my DataFlow services?”
“Can I filter and sort the list of projects?”
Tell an agent
List my DataFlow projects.
List projects filtered by {filters}.
Ask an LLM
“What ReadyFlows are available in the gallery?”
“Can I search ReadyFlows by keyword?”
Tell an agent
List ReadyFlows.
Find ReadyFlows matching {searchTerm}.
POST
/api/v1/df/listServiceActiveAlerts
List active alerts for a service · List active alerts for service
#
Ask an LLM
“Is my DataFlow service raising any alerts right now?”
“Can I sort the active alerts on a DataFlow service?”
Tell an agent
List active alerts for service {serviceCrn}.
Show current alerts on DataFlow service {serviceCrn}.
Ask an LLM
“What events has my DataFlow service recorded?”
“Can I filter service events from a start timestamp?”
Tell an agent
List events for service {serviceCrn}.
Show events for service {serviceCrn} since {timestampFrom}.
POST
/api/v1/df/listServiceSystemMetrics
Get system metrics for a service · List service System metrics
#
Ask an LLM
“What system metrics does my DataFlow service report?”
“Can I view a service's system metrics for a chosen time period?”
Tell an agent
Get system metrics for service {serviceCrn} over {metricsTimePeriod}.
Show service {serviceCrn} system metrics for {metricsTimePeriod}.
Ask an LLM
“Which environments have DataFlow services enabled?”
“Can I search my DataFlow services by name?”
Tell an agent
List my DataFlow services.
Find DataFlow services matching {searchTerm}.
POST
/api/v1/df/listUserKubernetesAccess
List users with access to a service's cluster · List users that have access to the service's cluster
#
Ask an LLM
“Who has Kubernetes access to my DataFlow service's cluster?”
“Can I audit which remote users can reach a DataFlow cluster?”
Tell an agent
List users with cluster access on service {serviceCrn}.
Show who can access the Kubernetes cluster of {serviceCrn}.
Ask an LLM
“How do I renew the workload UI certificates for a DataFlow service?”
“Can I refresh expiring UI certificates on a service?”
Tell an agent
Renew UI certificates for service {serviceCrn}.
Renew workload certificates on DataFlow service {serviceCrn}.
POST
/api/v1/df/resetService
Reset a non-enabled DataFlow service · Resets all references to a service.
#
Ask an LLM
“Can I reset references to a DataFlow service that isn't enabled?”
“Does resetting a service clean up its cloud resources?”
Tell an agent destructive · confirm first
Reset DataFlow service {serviceCrn}.
Clear all references to the non-enabled service {serviceCrn}.
POST
/api/v1/df/revokeUserKubernetesAccess
Revoke a user's access to the cluster · Revoke access for the remote user from the service's cluster
#
Ask an LLM
“Is there a way to remove a remote user's access to a DataFlow cluster?”
“Can I revoke Kubernetes access I granted to a cloud user?”
Tell an agent destructive · confirm first
Revoke cluster access for {cloudUserId} on service {serviceCrn}.
Remove {cloudUserId}'s Kubernetes access to {serviceCrn}.
Ask an LLM
“Can I rotate the database server root password for a DataFlow service?”
“What changes the DataFlow service's database root credentials?”
Tell an agent
Rotate the database root password for service {serviceCrn}.
Rotate DB root password on {serviceCrn}.
POST
/api/v1/df/startGetDiagnosticsCollection
Start a diagnostics bundle collection · Start diagnostics collection
#
Ask an LLM
“How do I collect a diagnostics bundle for a support case?”
“Can I include NiFi diagnostics in a DataFlow diagnostic bundle?”
Tell an agent
Collect diagnostics for service {dfServiceCrn} to {destination} with description {description}.
Start a diagnostics bundle for {dfServiceCrn} to {destination} for case {caseNumber}, described as {description}.
Ask an LLM
“Can I rename a catalog collection?”
“What's the way to change a collection's description?”
Tell an agent
Rename collection {catalogCollectionCrn} to {name}.
Set the description of collection {catalogCollectionCrn} to {description}.
POST
/api/v1/df/updateNodeImages
Update node images for a DataFlow service · Update cloud provider node images
#
Ask an LLM
“How do I update the cloud node images my DataFlow service runs on?”
“Will the service be unavailable while node images are updated?”
Tell an agent
Update node images for service {serviceCrn}.
Move DataFlow service {serviceCrn} nodes to the latest image.
Ask an LLM
“Can I rename a DataFlow project?”
“What's needed to change a project's description?”
Tell an agent
Rename project {projectCrn} at revision {projectRevision} to {projectName}.
Set project {projectCrn} (revision {projectRevision}) description to {projectDescription}.
Ask an LLM
“Can I change the min and max node count of an enabled DataFlow service?”
“Is it possible to update the authorized IP ranges for a service's Kubernetes API?”
Tell an agent
Scale service {serviceCrn} to between {minK8sNodeCount} and {maxK8sNodeCount} nodes.
Update service {serviceCrn} with {minK8sNodeCount}-{maxK8sNodeCount} nodes and API IP ranges {kubeApiAuthorizedIpRanges}.
Ask an LLM
“How do I upgrade DataFlow to the latest version?”
“Can I also upgrade the NiFi version of deployments when upgrading the service?”
Tell an agent
Upgrade DataFlow service {serviceCrn}.
Upgrade service {serviceCrn} with the deployments NiFi upgrade set to {upgradeDeploymentsNifiVersion}.
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
Schemas & Data
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-enable-service-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-start-get-diagnostics-collection-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-list-deployment-events-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-import-flow-definition-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-update-service-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-list-flows-in-deployment-request-schema.json