Apache NiFi

Apache NiFi Connectors API

The Connectors API from Apache NiFi — 37 operation(s) for connectors.

GitHub OpenAPI

Operations 47

POST /connectors Creates a new connector #
GET /connectors/{connectorId}/flow/process-groups/{processGroupId} Gets the flow for a process group within a connector #
GET /connectors/{connectorId}/flow/process-groups/{processGroupId}/controller-services Gets all controller services for a process group within a connector #
GET /connectors/{connectorId}/flow/process-groups/{processGroupId}/parameter-context Gets the parameter context bound to a process group within a connector #
DELETE /connectors/{id} Deletes a connector #
GET /connectors/{id} Gets a connector #
PUT /connectors/{id} Updates a connector #
POST /connectors/{id}/apply-update Applies an update to a connector #
GET /connectors/{id}/assets Lists the assets that belong to the Connector with the given ID #
POST /connectors/{id}/assets Creates a new Asset in the given Connector #
GET /connectors/{id}/assets/{assetId} Retrieves the content of the asset with the given id for a connector #
POST /connectors/{id}/backlog-requests Initiates a request to determine the current backlog for a Connector #
DELETE /connectors/{id}/backlog-requests/{requestId} Deletes the Backlog Request with the given ID #
GET /connectors/{id}/backlog-requests/{requestId} Returns the Backlog Request with the given ID #
GET /connectors/{id}/configuration-steps Gets all configuration step names for a connector #
GET /connectors/{id}/configuration-steps/{configurationStepName} Gets a specific configuration step by name for a connector #
PUT /connectors/{id}/configuration-steps/{configurationStepName} Updates a specific configuration step by name for a connector #
GET /connectors/{id}/configuration-steps/{configurationStepName}/property-groups/{propertyGroupName}/properties/{propertyName}/allowable-values Gets the allowable values for a specific property in a connector's… #
POST /connectors/{id}/configuration-steps/{configurationStepName}/verify-config Performs verification of a configuration step for a connector #
DELETE /connectors/{id}/configuration-steps/{configurationStepName}/verify-config/{requestId} Deletes the Verification Request with the given ID #
GET /connectors/{id}/configuration-steps/{configurationStepName}/verify-config/{requestId} Returns the Verification Request with the given ID #
GET /connectors/{id}/connections/{connectionId}/status/history Gets the status history for a connection within a connector #
GET /connectors/{id}/controller-services/{controllerServiceId} Gets a controller service within a connector #
GET /connectors/{id}/controller-services/{controllerServiceId}/state Gets the state for a controller service within a connector #
POST /connectors/{id}/controller-services/{controllerServiceId}/state/clear-requests Clears the state for a controller service within a connector #
DELETE /connectors/{id}/drain Cancels the draining of FlowFiles for a connector #
POST /connectors/{id}/drain Initiates draining of FlowFiles for a connector #
POST /connectors/{id}/migration-payloads Uploads a flow snapshot payload for a later Connector migration request #
POST /connectors/{id}/migration-requests Creates a Connector migration request #
DELETE /connectors/{id}/migration-requests/{requestId} Deletes the Connector migration request with the given ID #
GET /connectors/{id}/migration-requests/{requestId} Gets the Connector migration request with the given ID #
GET /connectors/{id}/migration-sources Lists the Versioned Process Groups that the Connector can be migrated from #
GET /connectors/{id}/process-groups/{processGroupId}/status/history Gets the status history for a process group within a connector #
GET /connectors/{id}/processors/{processorId}/state Gets the state for a processor within a connector #
POST /connectors/{id}/processors/{processorId}/state/clear-requests Clears the state for a processor within a connector #
GET /connectors/{id}/processors/{processorId}/status/history Gets the status history for a processor within a connector #
POST /connectors/{id}/purge-requests Creates a request to purge the FlowFiles for this connector #
DELETE /connectors/{id}/purge-requests/{purge-request-id} Cancels and/or removes a request to purge the FlowFiles for this connector #
GET /connectors/{id}/purge-requests/{purge-request-id} Gets the current status of a purge request for the specified connector #
GET /connectors/{id}/remote-process-groups/{remoteProcessGroupId}/status/history Gets the status history for a remote process group within a connector #
PUT /connectors/{id}/run-status Updates run status of a connector #
GET /connectors/{id}/search-results Performs a search against the encapsulated process group of this connector… #
GET /connectors/{id}/secrets Gets all secrets available for configuring a connector #
GET /connectors/{id}/status Gets the status for the process group managed by a connector #
DELETE /connectors/{id}/troubleshooting Transitions a Connector out of Troubleshooting mode #
POST /connectors/{id}/troubleshooting Transitions a Connector into Troubleshooting mode #
DELETE /connectors/{id}/working-configuration Discards the working configuration of a connector #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apache-nifi/refs/heads/main/openapi/apache-nifi-connectors-api-openapi.yml

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/apache-nifi:apache-nifi-connectors-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

apache-nifi-connectors-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: dev@nifi.apache.org
    url: https://nifi.apache.org
  description: REST API definition for Apache NiFi web services
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Apache NiFi REST Connectors API
  version: 2.12.0
security:
- HTTPBearerJWT: []
- CookieSecureAuthorizationBearer: []
tags:


# --- truncated at 32 KB (270 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apache-nifi/refs/heads/main/openapi/apache-nifi-connectors-api-openapi.yml