# Apache NiFi Connectors API

**Canonical:** https://apis.io/apis/apache-nifi/apache-nifi-connectors-api/  
**Provider:** Apache NiFi — https://apis.io/providers/apache-nifi/  
**Documentation:** https://nifi.apache.org/documentation/

Apache NiFi Connectors API is one of 31 APIs that [Apache NiFi](https://apis.io/providers/apache-nifi/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Connectors. The published artifact set on APIs.io includes an OpenAPI specification.

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

## Operations (47)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (1)

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

## Other Apache NiFi APIs (12)

- [Apache NiFi Registry](https://apis.io/apis/apache-nifi/apache-nifi-registry/)
- [Apache MiNiFi](https://apis.io/apis/apache-nifi/apache-minifi/)
- [Apache NiFi Access API](https://apis.io/apis/apache-nifi/apache-nifi-access-api/)
- [Apache NiFi Connections API](https://apis.io/apis/apache-nifi/apache-nifi-connections-api/)
- [Apache NiFi Controller Services API](https://apis.io/apis/apache-nifi/apache-nifi-controller-services-api/)
- [Apache NiFi Flow API](https://apis.io/apis/apache-nifi/apache-nifi-flow-api/)
- [Apache NiFi Authentication API](https://apis.io/apis/apache-nifi/apache-nifi-authentication-api/)
- [Apache NiFi Controller API](https://apis.io/apis/apache-nifi/apache-nifi-controller-api/)
- [Apache NiFi Counters API](https://apis.io/apis/apache-nifi/apache-nifi-counters-api/)
- [Apache NiFi Data Transfer API](https://apis.io/apis/apache-nifi/apache-nifi-datatransfer-api/)
- [Apache NiFi Flow File Queues API](https://apis.io/apis/apache-nifi/apache-nifi-flowfilequeues-api/)
- [Apache NiFi Funnels API](https://apis.io/apis/apache-nifi/apache-nifi-funnels-api/)

## Tags

Connectors

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/apache-nifi/apache-nifi-connectors-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/apache-nifi/.