Cloudera

Cloudera CDF Local RPCAPI Version1 API

The CDFLocalRPCAPIVersion1 API from Cloudera — 71 operation(s) for cdflocalrpcapiversion1.

GitHub OpenAPI

Operations 71

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

POST /dfx/api/rpc-v1/custom-nar-configurations/create-custom-nar-configuration Create a custom NAR configuration · Create the custom NAR configuration #
Ask an LLM
“How do I point DataFlow at a storage location holding my custom NiFi NAR files?”
“What credentials does a new custom NAR configuration need for its storage location?”
Tell an agent
Create a custom NAR configuration in environment {environment} using storage location {storage} with user {username}.
Set up a new custom NAR configuration for project {project} in environment {environment}.
POST /dfx/api/rpc-v1/custom-nar-configurations/delete-custom-nar-configuration Delete an orphaned custom NAR configuration · Deletes an orphaned custom NAR configuration #
Ask an LLM
“Can I remove a custom NAR configuration that no deployment uses anymore?”
“How do I clean up an orphaned custom NAR configuration in DataFlow?”
Tell an agent destructive · confirm first
Delete orphaned custom NAR configuration {config} in environment {environment}.
Remove the unused custom NAR configuration {config} at version {version}.
POST /dfx/api/rpc-v1/custom-nar-configurations/get-custom-nar-configuration Get a custom NAR configuration · Get a custom NAR configuration #
Ask an LLM
“Which custom NAR configuration is a given flow deployment using?”
“Can I look up the details of one custom NAR configuration by its CRN?”
Tell an agent
Show the custom NAR configuration {config} in environment {environment}.
Get the custom NAR configuration used by deployment {deployment}.
POST /dfx/api/rpc-v1/custom-nar-configurations/get-default-custom-nar-configuration Get the default custom NAR configuration (deprecated) · Get the default custom NAR configuration. Deprecated, no longer supported #
Ask an LLM
“Is there still a default custom NAR configuration for an environment?”
“What does the deprecated default custom NAR configuration call return?”
Tell an agent
Fetch the default custom NAR configuration for environment {environment} using the deprecated call.
Check the legacy default NAR configuration of environment {environment}.
POST /dfx/api/rpc-v1/custom-nar-configurations/update-custom-nar-configuration Update a custom NAR configuration · Update the custom NAR configuration #
Ask an LLM
“Can I change the storage location or password on an existing custom NAR configuration?”
“How do I rotate the credentials of a custom NAR configuration I already created?”
Tell an agent
Update custom NAR configuration {config} to use storage location {storage}.
Change the username on the custom NAR configuration in environment {environment} to {username}.
POST /dfx/api/rpc-v1/custom-nar-configurations/validate-custom-nar-configuration Validate custom NAR configuration settings · Validates the custom NAR configuration #
Ask an LLM
“Can I test whether my NAR storage location and credentials work before saving them?”
“Will DataFlow be able to reach my custom NAR files with these credentials?”
Tell an agent
Validate custom NAR settings for storage location {storage} with user {username} in environment {environment}.
Check that the NAR storage at {storage} is reachable before I create the configuration.
POST /dfx/api/rpc-v1/custom-python-configurations/create-custom-python-configuration Create a custom Python configuration · Create the custom Python configuration #
Ask an LLM
“How do I give DataFlow access to my own Python processors in cloud storage?”
“What is required to register a custom Python configuration for an environment?”
Tell an agent
Create a custom Python configuration in environment {environment} pointing at {storage} with user {username}.
Register a custom Python configuration for project {project}.
POST /dfx/api/rpc-v1/custom-python-configurations/delete-custom-python-configuration Delete an orphaned custom Python configuration · Deletes an orphaned custom Python configuration #
Ask an LLM
“Can I delete a custom Python configuration that is no longer attached to anything?”
“How do I get rid of an orphaned custom Python configuration?”
Tell an agent destructive · confirm first
Delete orphaned custom Python configuration {config} in environment {environment}.
Remove unused custom Python configuration {config} at version {version}.
POST /dfx/api/rpc-v1/custom-python-configurations/get-custom-python-configuration Get a custom Python configuration · Get a custom Python configuration #
Ask an LLM
“Which custom Python configuration does a given deployment rely on?”
“Can I see the storage location set on one custom Python configuration?”
Tell an agent
Show custom Python configuration {config} in environment {environment}.
Get the custom Python configuration used by deployment {deployment}.
POST /dfx/api/rpc-v1/custom-python-configurations/update-custom-python-configuration Update a custom Python configuration · Update the custom Python configuration #
Ask an LLM
“Can I move an existing custom Python configuration to a different storage location?”
“How do I change the password on my custom Python configuration?”
Tell an agent
Update custom Python configuration {config} to read from {storage}.
Change the user on custom Python configuration {config} to {username}.
POST /dfx/api/rpc-v1/custom-python-configurations/validate-custom-python-configuration Validate custom Python configuration settings · Validates the custom Python configuration #
Ask an LLM
“Can I check my Python processor storage credentials before creating the configuration?”
“Will these settings work for a custom Python configuration?”
Tell an agent
Validate custom Python settings for storage {storage} with user {username} in environment {environment}.
Test that the Python processor location {storage} is accessible.
POST /dfx/api/rpc-v1/deployed-flows/abort-flow-request-in-deployment Abort a flow request in a deployment · Aborts a flow request in deployment #
Ask an LLM
“Can I back out of adding a flow to a deployment before it finishes?”
“How do I abandon a pending deployed-flow request?”
Tell an agent destructive · confirm first
Abort deployed flow request {request} in environment {environment}.
Cancel the in-progress flow request {request}.
POST /dfx/api/rpc-v1/deployed-flows/add-flow-to-deployment Add a flow to an existing deployment · Adds a flow to an existing deployment #
Ask an LLM
“Can I run more than one NiFi flow inside the same DataFlow deployment?”
“Is it possible to add a flow to a deployment without starting it automatically?”
Tell an agent
Add flow {name} to deployment {deployment} using flow request {request}.
Add flow {name} to deployment {deployment} and start it right away ({autostart}).
POST /dfx/api/rpc-v1/deployed-flows/cancel-change-flow-version-in-deployment Cancel a flow version change for a deployed flow · Cancel change flow version for an existing flow deployment #
Ask an LLM
“Can I stop a version change on one flow inside a multi-flow deployment?”
“What happens if I cancel a flow version change that is still running?”
Tell an agent destructive · confirm first
Cancel the version change for deployed flow {flow} in deployment {deployment}.
Stop changing the version of flow {flow} in environment {environment}.
POST /dfx/api/rpc-v1/deployed-flows/change-flow-version-in-deployment Change the version of a deployed flow · Change flow version of a running deployed flow #
Ask an LLM
“How do I roll a running deployed flow onto a newer flow definition version?”
“Can I choose a strategy and a stop timeout when switching one flow's version?”
Tell an agent
Change the version of deployed flow {flow} in deployment {deployment}.
Switch flow {flow} to its new version using strategy {strategy}, waiting {minutes} minutes for it to stop.
POST /dfx/api/rpc-v1/deployed-flows/get-flow-configuration-in-deployment Get a deployed flow's configuration · Retrieves the deployed flow configuration in a deployment #
Ask an LLM
“What parameters and KPIs is one flow inside my deployment configured with?”
“Can I read back the configuration of a single deployed flow?”
Tell an agent
Show the configuration of deployed flow {flow} in deployment {deployment}.
Get the flow configuration for {flow} in environment {environment}.
POST /dfx/api/rpc-v1/deployed-flows/get-flow-configuration-metadata-in-deployment Get a deployed flow's configuration metadata · Retrieves the deployed flow configuration metadata in a deployment #
Ask an LLM
“Where can I find metadata about a deployed flow's configuration rather than the configuration itself?”
“Which configuration version is a given deployed flow on?”
Tell an agent
Get the configuration metadata of deployed flow {flow} in deployment {deployment}.
Fetch configuration metadata for flow {flow}.
POST /dfx/api/rpc-v1/deployed-flows/get-flow-request-details-in-deployment Get and register a flow request in a deployment · Retrieves flow request details and registers the flow deployment request #
Ask an LLM
“How do I register a request to add a flow into an existing deployment?”
“What details come back for a deployed-flow request?”
Tell an agent
Get the details of deployed flow request {request} and register it.
Register flow request {request} in environment {environment}.
POST /dfx/api/rpc-v1/deployed-flows/import-flow-into-deployment Import a flow configuration into a deployment · Import flow deployment configuration #
Ask an LLM
“Can I bring one flow from an exported archive into an existing deployment?”
“Which archive and flow name do I need to import a flow into a deployment?”
Tell an agent
Import flow {flow} from archive {archive} into the deployment for request {request}.
Load flow {flow} from exported archive {archive} as an additional deployed flow.
POST /dfx/api/rpc-v1/deployed-flows/start-flow-in-deployment Start one flow in a deployment · Starts a flow in a deployment #
Ask an LLM
“How do I start a single NiFi flow without starting every flow in the deployment?”
“Can I resume processing on one deployed flow that I stopped?”
Tell an agent
Start deployed flow {flow} in deployment {deployment}.
Turn flow {flow} back on in environment {environment}.
POST /dfx/api/rpc-v1/deployed-flows/stop-flow-in-deployment Stop one flow in a deployment · Stops a flow in a deployment #
Ask an LLM
“Can I stop just one NiFi flow while the rest of the deployment keeps running?”
“How long will DataFlow wait for a single deployed flow to stop?”
Tell an agent
Stop deployed flow {flow} in deployment {deployment}.
Stop flow {flow} and wait up to {minutes} minutes for it to drain.
POST /dfx/api/rpc-v1/deployed-flows/terminate-flow-in-deployment Terminate one flow in a deployment · Terminates a flow in a deployment #
Ask an LLM
“How do I permanently remove one flow from a multi-flow deployment?”
“Can I terminate a single deployed flow without terminating the whole deployment?”
Tell an agent destructive · confirm first
Terminate deployed flow {flow} in deployment {deployment}.
Remove flow {flow} from its deployment in environment {environment}.
POST /dfx/api/rpc-v1/deployed-flows/update-flow-in-deployment Update one flow in a deployment · Updates a flow deployment #
Ask an LLM
“Can I change parameter groups or KPIs on one flow inside a deployment?”
“Which settings of a single deployed flow can I update in place?”
Tell an agent
Update the parameter groups of deployed flow {flow} in deployment {deployment}.
Apply new KPIs {kpis} to flow {flow} at configuration version {version}.
POST /dfx/api/rpc-v1/deployments/abort-asset-update-request Abort an asset update request · Aborts asset update request #
Ask an LLM
“Can I throw away an asset update request I started for a deployment?”
“How do I abandon pending asset changes on a deployment?”
Tell an agent destructive · confirm first
Abort asset update request {request} on deployment {deployment}.
Discard the asset update request {request} for flow {flow}.
POST /dfx/api/rpc-v1/deployments/abort-deployment-request Abort a deployment request · Aborts a deployment request #
Ask an LLM
“Can I cancel a deployment request before the deployment is created?”
“How do I abandon a half-finished deployment request?”
Tell an agent destructive · confirm first
Abort deployment request {request} in environment {environment}.
Drop the pending deployment request {request}.
POST /dfx/api/rpc-v1/deployments/cancel-change-flow-version Cancel a deployment's flow version change (legacy) · Cancel change flow version for an existing deployment. #
Ask an LLM
“Is there an older deployment-level call to cancel a flow version change?”
“Can I still cancel a version change for a whole single-flow deployment the legacy way?”
Tell an agent destructive · confirm first
Cancel the flow version change on deployment {deployment} using the deprecated deployment-level call.
Use the legacy endpoint to stop the version change on deployment {deployment} in {environment}.
POST /dfx/api/rpc-v1/deployments/cancel-nifi-version-update Cancel a NiFi version update · Cancels a NiFi version update for a deployment #
Ask an LLM
“Can I back out of a NiFi version upgrade that is in progress on a deployment?”
“How do I cancel an ongoing NiFi runtime update?”
Tell an agent destructive · confirm first
Cancel the NiFi version update on deployment {deployment}.
Stop the NiFi upgrade running on deployment {deployment} in environment {environment}.
POST /dfx/api/rpc-v1/deployments/change-flow-version Change a deployment's flow version (legacy) · Change flow version of a running deployment. #
Ask an LLM
“Is there a deprecated way to change the flow version of a whole deployment?”
“Which legacy call changes the flow version on a single-flow deployment?”
Tell an agent
Change the flow version of deployment {deployment} using the deprecated deployment-level call.
Use the legacy endpoint to move deployment {deployment} to a new flow version with strategy {strategy}.
POST /dfx/api/rpc-v1/deployments/create-asset-update-request Start an asset update request for a deployment · Create asset update request #
Ask an LLM
“How do I begin replacing files and assets used by a running deployment?”
“What do I need before uploading new assets to an existing deployment?”
Tell an agent
Create an asset update request for deployment {deployment}.
Open an asset update request for flow {flow} in deployment {deployment}.
POST /dfx/api/rpc-v1/deployments/create-deployment Create a flow deployment · Creates a deployment #
Ask an LLM
“How do I deploy a NiFi flow to DataFlow with autoscaling between a minimum and maximum node count?”
“Can I pick the NiFi version and cluster size when creating a deployment?”
Tell an agent
Create deployment {name} in environment {environment} from deployment request {request}.
Create deployment {name} with autoscaling from {min} to {max} nodes.
POST /dfx/api/rpc-v1/deployments/create-reporting-task Create a reporting task in a deployment · Creates a reporting task #
Ask an LLM
“How do I add a NiFi reporting task to a deployment from a definition file?”
“Can I attach a reporting task to a deployment?”
Tell an agent
Create a reporting task from file {file} in deployment {deployment}.
Add the reporting task defined in {file} in environment {environment}.
POST /dfx/api/rpc-v1/deployments/delete-reporting-task Delete a reporting task · Deletes a reporting task #
Ask an LLM
“Can I remove a reporting task from a deployment?”
“How do I get rid of a NiFi reporting task I no longer need?”
Tell an agent destructive · confirm first
Delete reporting task {task} from deployment {deployment}.
Remove reporting task {task} in environment {environment}.
POST /dfx/api/rpc-v1/deployments/export-deployment Export a deployment's configuration · Export deployment configuration #
Ask an LLM
“How do I export a deployment's configuration to an archive I can import elsewhere?”
“Can I add a description to an exported deployment archive?”
Tell an agent
Export the configuration of deployment {deployment}.
Export deployment {deployment} with archive description {description}.
POST /dfx/api/rpc-v1/deployments/get-deployment-configuration Get a deployment's configuration · Retrieves the deployment configuration #
Ask an LLM
“What scaling, inbound and parameter settings is my deployment running with?”
“Can I read back the full configuration of a deployment?”
Tell an agent
Show the configuration of deployment {deployment}.
Get deployment {deployment}'s settings in environment {environment}.
POST /dfx/api/rpc-v1/deployments/get-deployment-configuration-metadata Get a deployment's configuration metadata · Retrieves the deployment configuration metadata #
Ask an LLM
“Which configuration version is my deployment currently on?”
“Where do I find metadata about a deployment's configuration?”
Tell an agent
Get the configuration metadata for deployment {deployment}.
Check the current configuration version of deployment {deployment} in {environment}.
POST /dfx/api/rpc-v1/deployments/get-deployment-request-details Get and register a deployment request · Retrieves deployment request details and registers the deployment request #
Ask an LLM
“How do I register a deployment request before creating the deployment?”
“What details does a new deployment request return?”
Tell an agent
Get the details of deployment request {request} and register it.
Register deployment request {request} in environment {environment}.
POST /dfx/api/rpc-v1/deployments/import-deployment Import a deployment from an archive · Import deployment configuration #
Ask an LLM
“Can I recreate a deployment from a previously exported archive?”
“How do I import a whole deployment configuration into another environment?”
Tell an agent
Import deployment configuration from archive {archive} for deployment request {request}.
Import archive {archive} as a new deployment in environment {environment}.
POST /dfx/api/rpc-v1/deployments/list-deployment-archives List exported deployment archives · Lists the exported archive metadata of all deployments #
Ask an LLM
“Which deployment exports are available to import?”
“Can I search exported deployment archives by name?”
Tell an agent
List exported deployment archives in environment {environment}.
Find exported deployment archives matching {term}.
POST /dfx/api/rpc-v1/deployments/list-reporting-tasks List a deployment's reporting tasks · Lists all reporting tasks for a deployment #
Ask an LLM
“What reporting tasks are configured on my deployment?”
“Can I see every NiFi reporting task in an environment?”
Tell an agent
List reporting tasks for deployment {deployment}.
Show all reporting tasks in environment {environment}.
POST /dfx/api/rpc-v1/deployments/restart-deployment Restart a deployment · Restart a deployment #
Ask an LLM
“How do I restart a DataFlow deployment that is misbehaving?”
“Can I force the flows to stop when restarting a deployment?”
Tell an agent
Restart deployment {deployment}.
Restart deployment {deployment} and force-stop its flows ({force}).
POST /dfx/api/rpc-v1/deployments/resume-deployment Resume a suspended deployment · Resumes a deployment #
Ask an LLM
“How do I bring a suspended deployment back online?”
“Can I resume a deployment I paused to save resources?”
Tell an agent
Resume suspended deployment {deployment}.
Wake up deployment {deployment} in environment {environment}.
POST /dfx/api/rpc-v1/deployments/start-all-flows-in-deployment Start all flows in a deployment · Starts all flows in a deployment #
Ask an LLM
“Can I start every NiFi flow in a deployment at once?”
“What call turns on all flows in a multi-flow deployment?”
Tell an agent
Start all flows in deployment {deployment}.
Turn on every flow in deployment {deployment} in environment {environment}.
POST /dfx/api/rpc-v1/deployments/start-flow Start a deployment's flow (legacy) · Starts a flow. Deprecated, use start-flow-in-deployment #
Ask an LLM
“Is there an older deployment-level call to start a NiFi flow?”
“Which deprecated endpoint starts the flow of a single-flow deployment?”
Tell an agent
Start the flow of deployment {deployment} using the deprecated start-flow call.
Use the legacy endpoint to start deployment {deployment}'s flow in {environment}.
POST /dfx/api/rpc-v1/deployments/stop-all-flows-in-deployment Stop all flows in a deployment · Stops all flows in a deployment #
Ask an LLM
“Can I stop every NiFi flow in a deployment in one call?”
“How long can I wait for all flows in a deployment to stop?”
Tell an agent
Stop all flows in deployment {deployment}.
Stop every flow in deployment {deployment} and wait up to {minutes} minutes.
POST /dfx/api/rpc-v1/deployments/stop-flow Stop a deployment's flow (legacy) · Stops a flow. Deprecated, use stop-flow-in-deployment #
Ask an LLM
“Is there a deprecated deployment-level call to stop a NiFi flow?”
“Which legacy endpoint stops the flow of a single-flow deployment?”
Tell an agent
Stop the flow of deployment {deployment} using the deprecated stop-flow call.
Use the legacy endpoint to stop deployment {deployment}'s flow, waiting {minutes} minutes.
POST /dfx/api/rpc-v1/deployments/suspend-deployment Suspend a deployment · Suspends a deployment #
Ask an LLM
“Can I pause a deployment without terminating it?”
“How do I suspend a DataFlow deployment I am not using right now?”
Tell an agent
Suspend deployment {deployment}.
Put deployment {deployment} in environment {environment} into a suspended state.
POST /dfx/api/rpc-v1/deployments/terminate-deployment Terminate a deployment · Terminates a deployment #
Ask an LLM
“How do I permanently tear down a whole DataFlow deployment?”
“What happens to all flows when I terminate a deployment?”
Tell an agent destructive · confirm first
Terminate deployment {deployment}.
Tear down deployment {deployment} in environment {environment}.
POST /dfx/api/rpc-v1/deployments/update-deployment Update a deployment's settings · Updates a deployment #
Ask an LLM
“Can I change the autoscaling limits or cluster size of an existing deployment?”
“How do I deactivate the inbound connection on a running deployment?”
Tell an agent
Update deployment {deployment} to scale between {min} and {max} nodes.
Change deployment {deployment} to cluster size {size} at configuration version {version}.
POST /dfx/api/rpc-v1/deployments/update-nifi-version Update a deployment's NiFi version · Updates the NiFi version of a deployment #
Ask an LLM
“How do I upgrade the NiFi runtime of a deployment?”
“Can I move a deployment to a specific NiFi version?”
Tell an agent
Update deployment {deployment} to NiFi version {nifi}.
Upgrade the NiFi version of deployment {deployment} in {environment} to {nifi}.
POST /dfx/api/rpc-v1/deployments/upload-asset Upload an asset for a deployment request · Upload an asset #
Ask an LLM
“How do I upload a file referenced by a flow parameter while creating a deployment?”
“Can I upload an asset as part of an asset update request?”
Tell an agent
Upload {file} as parameter {parameter} in group {group} for deployment request {request}.
Upload file {file} for parameter {parameter} under asset update request {update}.
POST /dfx/api/rpc-v1/environments/list-nifi-versions List supported NiFi versions · Lists all supported NiFi versions #
Ask an LLM
“Which NiFi versions can I deploy flows on?”
“What NiFi runtimes are supported in my environment?”
Tell an agent
List the supported NiFi versions in environment {environment}.
Show NiFi versions available for deployments in {environment}.
POST /dfx/api/rpc-v1/fd-proxy/delete-flow-draft Delete a flow draft · Deletes flow draft #
Ask an LLM
“Can I delete a flow draft I was designing?”
“How do I remove an old flow draft from the designer?”
Tell an agent destructive · confirm first
Delete flow draft {draft} in environment {environment}.
Remove the flow draft {draft}.
POST /dfx/api/rpc-v1/fd-proxy/list-flow-drafts List flow drafts · Lists flow drafts #
Ask an LLM
“What flow drafts exist in the designer for my environment?”
“Can I see all the work-in-progress flows in an environment?”
Tell an agent
List flow drafts in environment {environment}.
Show my designer flow drafts for {environment}.
POST /dfx/api/rpc-v1/fd-proxy/list-test-sessions List flow designer test sessions · Lists test sessions #
Ask an LLM
“Which designer test sessions are running in my environment?”
“Can I see all test sessions for my flow drafts?”
Tell an agent
List test sessions in environment {environment}.
Show active flow designer test sessions for {environment}.
POST /dfx/api/rpc-v1/fd-proxy/restart-test-session Restart a test session · Restarts test session #
Ask an LLM
“How do I restart the test session behind a flow draft?”
“Can I bring a suspended test session back up?”
Tell an agent
Restart the test session for flow draft {draft}.
Restart test session of draft {draft} in environment {environment}.
POST /dfx/api/rpc-v1/fd-proxy/suspend-test-session Suspend a test session · Suspends test session #
Ask an LLM
“Can I pause a flow draft's test session to save resources?”
“How do I suspend a test session I am not using?”
Tell an agent
Suspend the test session for flow draft {draft}.
Pause test session of draft {draft} in environment {environment}.
POST /dfx/api/rpc-v1/fd-proxy/terminate-test-session Terminate a test session · Terminates test session #
Ask an LLM
“How do I shut down a flow draft's test session for good?”
“Can I terminate a test session rather than just suspend it?”
Tell an agent destructive · confirm first
Terminate the test session for flow draft {draft}.
End test session of draft {draft} in environment {environment}.
POST /dfx/api/rpc-v1/inbound-connection-endpoint-certificates/download-client-certificates-encoded Download inbound endpoint client certificates · Get Inbound Connection Endpoint Client Certificates (in PEM encoding) #
Ask an LLM
“Where do I get the PEM client certificates for an inbound connection endpoint?”
“Can I download client certs so a data source can send to my deployment?”
Tell an agent
Download the PEM client certificates for inbound connection endpoint {endpoint}.
Get client certificates of endpoint {endpoint} in environment {environment}.
POST /dfx/api/rpc-v1/inbound-connection-endpoints/create-inbound-connection-endpoint Create an inbound connection endpoint · Create Inbound Connection Endpoint #
Ask an LLM
“How do I create an endpoint so external clients can push data into DataFlow?”
“Can I choose the hostname of a new inbound connection endpoint?”
Tell an agent
Create an inbound connection endpoint with hostname {hostname} in environment {environment}.
Create an inbound connection endpoint for project {project}.
POST /dfx/api/rpc-v1/inbound-connection-endpoints/delete-inbound-connection-endpoint Delete an inbound connection endpoint · Delete Inbound Connection Endpoint #
Ask an LLM
“Can I delete an inbound connection endpoint I no longer need?”
“How do I remove an inbound endpoint from an environment?”
Tell an agent destructive · confirm first
Delete inbound connection endpoint {endpoint}.
Remove inbound endpoint {endpoint} from environment {environment}.
POST /dfx/api/rpc-v1/inbound-connection-endpoints/describe-inbound-connection-endpoint Describe an inbound connection endpoint · Describe Inbound Connection Endpoint #
Ask an LLM
“What hostname and status does one inbound connection endpoint have?”
“Can I look up a single inbound endpoint by its CRN?”
Tell an agent
Describe inbound connection endpoint {endpoint}.
Show details of inbound endpoint {endpoint} in {environment}.
POST /dfx/api/rpc-v1/inbound-connection-endpoints/list-inbound-connection-endpoints List inbound connection endpoints · List Inbound Connection Endpoints #
Ask an LLM
“Which inbound connection endpoints exist in my environment?”
“Can I see every endpoint external clients can send data to?”
Tell an agent
List inbound connection endpoints in environment {environment}.
Show all inbound endpoints for {environment}.
POST /dfx/api/rpc-v1/inbound-connection-endpoints/renew-certificates Renew inbound connection endpoint certificates · Renew Inbound Connection Endpoint certificates #
Ask an LLM
“How do I renew the server certificate on an inbound connection endpoint?”
“Can I revoke existing client certificates while renewing an endpoint's certs?”
Tell an agent
Renew the certificates of inbound connection endpoint {endpoint}.
Renew client certificates on endpoint {endpoint} and revoke the old ones ({revoke}).
POST /dfx/api/rpc-v1/parameter-groups/create-parameter-group Create a parameter group · Creates a new parameter group #
Ask an LLM
“How do I create a shared parameter group that flows can reuse?”
“Can I define parameters and a description when creating a parameter group?”
Tell an agent
Create parameter group {name} in environment {environment}.
Create parameter group {name} with parameters {parameters} for project {project}.
POST /dfx/api/rpc-v1/parameter-groups/delete-parameter-group Delete a parameter group · Deletes the parameter group #
Ask an LLM
“Can I delete a parameter group that is still attached to a deployment?”
“How do I remove an unused parameter group?”
Tell an agent destructive · confirm first
Delete parameter group {group}.
Remove unused parameter group {group} from environment {environment}.
POST /dfx/api/rpc-v1/parameter-groups/describe-parameter-group Describe a parameter group · Describes the parameter group with the given parameter group CRN #
Ask an LLM
“What parameters are inside a given parameter group?”
“Can I look up one parameter group by its CRN?”
Tell an agent
Describe parameter group {group}.
Show the parameters in group {group} in environment {environment}.
POST /dfx/api/rpc-v1/parameter-groups/duplicate-parameter-group Duplicate a parameter group · Duplicates the parameter group with the given CRN under the given new name #
Ask an LLM
“Can I copy an existing parameter group under a new name?”
“How do I clone a parameter group to make a variant of it?”
Tell an agent
Duplicate parameter group {group} as {newName}.
Copy parameter group {group} to {newName} with description {description}.
POST /dfx/api/rpc-v1/parameter-groups/list-parameter-groups List parameter groups · Lists all known parameter groups #
Ask an LLM
“Which parameter groups are defined in my environment?”
“Can I filter parameter groups by project or a search term?”
Tell an agent
List parameter groups in environment {environment}.
Find parameter groups matching {term} in projects {projects}.
POST /dfx/api/rpc-v1/parameter-groups/update-parameter-group Update a parameter group · Updates the parameter group for the given parameter group CRN #
Ask an LLM
“How do I add, change or remove parameters in an existing parameter group?”
“Can I delete a single parameter from a group by sending only its name?”
Tell an agent
Update parameter group {group} with parameters {parameters}.
Change the description of parameter group {group} to {description}.
POST /dfx/api/rpc-v1/parameter-groups/upload-parameter-asset Upload an asset to a parameter group · Uploads a parameter asset #
Ask an LLM
“Can I attach a file to a parameter inside a shared parameter group?”
“How do I upload a keystore or config file for a parameter group parameter?”
Tell an agent
Upload {file} for parameter {parameter} in parameter group {group}.
Attach file {file} to parameter group {group} parameter {parameter} in {environment}.
POST /dfx/api/rpc-v1/workload-resources/reassign-resources Move workload resources to another project · Modifies the project assignment of the given workload resources #
Ask an LLM
“Can I move deployments and other DataFlow resources into a different project?”
“How do I change which project a workload resource belongs to?”
Tell an agent
Reassign resources {resources} to project {project}.
Move workload resources {resources} in environment {environment} out of their current project.

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-cdflocalrpcapiversion1-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-deployment-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-update-deployment-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-change-flow-version-in-deployment-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-add-flow-to-deployment-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-change-flow-version-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-update-flow-in-deployment-request-schema.json

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:cloudera-cdflocalrpcapiversion1-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-cdflocalrpcapiversion1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'This REST API provides remote access to the DataFlow Service.

    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 CDF Local RPCAPI…
  license:
    name: Apache 2.0
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
tags:


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