# Apache NiFi Process Groups API

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

Apache NiFi Process Groups 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 ProcessGroups. The published artifact set on APIs.io includes an OpenAPI specification.

The ProcessGroups API from Apache NiFi — 22 operation(s) for processgroups.

## Operations (34)

| Method | Path | Summary |
|---|---|---|
| DELETE | `/process-groups/replace-requests/{id}` | Deletes the Replace Request with the given ID |
| GET | `/process-groups/replace-requests/{id}` | Returns the Replace Request with the given ID |
| DELETE | `/process-groups/{id}` | Deletes a process group |
| GET | `/process-groups/{id}` | Gets a process group |
| PUT | `/process-groups/{id}` | Updates a process group |
| GET | `/process-groups/{id}/connections` | Gets all connections |
| POST | `/process-groups/{id}/connections` | Creates a connection |
| POST | `/process-groups/{id}/controller-services` | Creates a new controller service |
| POST | `/process-groups/{id}/copy` | Generates a copy response for the given copy request |
| GET | `/process-groups/{id}/download` | Gets a process group for download |
| POST | `/process-groups/{id}/empty-all-connections-requests` | Creates a request to drop all FlowFiles of all connection queues in this… |
| DELETE | `/process-groups/{id}/empty-all-connections-requests/{drop-request-id}` | Cancels and/or removes a request to drop all FlowFiles |
| GET | `/process-groups/{id}/empty-all-connections-requests/{drop-request-id}` | Gets the current status of a drop all FlowFiles request |
| PUT | `/process-groups/{id}/flow-contents` | Replace Process Group contents with the given ID with the specified Process… |
| GET | `/process-groups/{id}/funnels` | Gets all funnels |
| POST | `/process-groups/{id}/funnels` | Creates a funnel |
| GET | `/process-groups/{id}/input-ports` | Gets all input ports |
| POST | `/process-groups/{id}/input-ports` | Creates an input port |
| GET | `/process-groups/{id}/labels` | Gets all labels |
| POST | `/process-groups/{id}/labels` | Creates a label |
| GET | `/process-groups/{id}/local-modifications` | Gets a list of local modifications to the Process Group since it was last… |
| GET | `/process-groups/{id}/output-ports` | Gets all output ports |
| POST | `/process-groups/{id}/output-ports` | Creates an output port |
| PUT | `/process-groups/{id}/paste` | Pastes into the specified process group |
| GET | `/process-groups/{id}/process-groups` | Gets all process groups |
| POST | `/process-groups/{id}/process-groups` | Creates a process group |
| POST | `/process-groups/{id}/process-groups/import` | Imports a specified process group |
| POST | `/process-groups/{id}/process-groups/upload` | Uploads a versioned flow definition and creates a process group |
| GET | `/process-groups/{id}/processors` | Gets all processors |
| POST | `/process-groups/{id}/processors` | Creates a new processor |
| GET | `/process-groups/{id}/remote-process-groups` | Gets all remote process groups |
| POST | `/process-groups/{id}/remote-process-groups` | Creates a new process group |
| POST | `/process-groups/{id}/replace-requests` | Initiate the Replace Request of a Process Group with the given ID |
| POST | `/process-groups/{id}/snippet-instance` | Copies a snippet and discards it |

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/apache-nifi/refs/heads/main/openapi/apache-nifi-processgroups-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 Connectors API](https://apis.io/apis/apache-nifi/apache-nifi-connectors-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/)

## Tags

ProcessGroups

---

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