Version, build, and identity information for the connected NiFi instance.

Backed by GET /flow/about and /flow/current-user. Use this first to confirm connectivity and learn which NiFi generation you are talking to.

JVM heap, thread counts, repository disk usage, and uptime.

Backed by GET /system-diagnostics. Use when diagnosing performance or memory pressure rather than flow logic.

Aggregate controller status: running/stopped/invalid counts, queued data, bulletins.

Backed by GET /flow/status and /flow/bulletin-board. The fastest way to answer "is anything wrong right now?".

Recursive process-group tree with processors and connections.

Backed by GET /flow/process-groups/{id}. depth bounds the recursion; groups beyond it are listed by id and name only. Start here to understand a flow's shape.

A process group's identity, component-state counts, and version-control state.

Backed by GET /process-groups/{id}. Pass "root" for the top-level group.

The direct contents of one process group: children, processors, connections, ports.

Backed by GET /flow/process-groups/{id}. Unlike nifi_flow_tree this does not recurse, so it is the cheaper choice when inspecting a single group.

Throughput and queue statistics for a process group, recursively.

Backed by GET /flow/process-groups/{id}/status.

Processors in a process group with run status, validity, and throughput.

Backed by GET /process-groups/{id}/processors.

One processor in full: properties, scheduling, relationships, validation errors.

Backed by GET /processors/{id}. Sensitive property values are masked.

Descriptor for one processor property: type, default, and allowable values.

Backed by GET /processors/{id}/descriptors. Use this before setting a property whose valid values you are unsure of.

Connections in a process group with queue depth and backpressure settings.

Backed by GET /process-groups/{id}/connections. queued.count and queued.bytes are numeric; the _display variants are formatted strings.

One connection: endpoints, routed relationships, queue depth, prioritizers.

Backed by GET /connections/{id}.

Search the flow for components by name, id, property value, or comment.

Backed by GET /flow/search-results — the same search the NiFi UI uses.

Recent bulletins — NiFi's warning and error notices.

Backed by GET /flow/bulletin-board. The first place to look when a processor is failing but its configuration looks correct.

Search the catalogue of installable component types by name, tag, or description.

Backed by GET /flow/processor-types and /flow/controller-service-types. kind is "processor", "controller_service", or "both". Use this to find the correct type before calling nifi_create_processor.

Controller services visible to a process group, with state and referencing components.

Backed by GET /flow/process-groups/{id}/controller-services.

One controller service: properties, state, and what references it.

Backed by GET /controller-services/{id}. Sensitive values are masked.

All parameter contexts and their parameters. Sensitive values are masked.

Backed by GET /flow/parameter-contexts.

One parameter context with its parameters and bound process groups.

Backed by GET /parameter-contexts/{id}.

List the flowfiles currently queued on a connection.

Backed by POST /flowfile-queues/{id}/listing-requests, polled to completion. This reads state only; it does not modify the queue.

Metadata and attributes for one queued flowfile.

Backed by GET /flowfile-queues/{id}/flowfiles/{uuid}.

Content of one queued flowfile, truncated to max_bytes.

Backed by GET /flowfile-queues/{id}/flowfiles/{uuid}/content. Binary content is returned base64-encoded, indicated by the encoding field.

Search provenance events to trace what happened to data.

Backed by POST /provenance, polled to completion. Dates use NiFi's MM/dd/yyyy HH:mm:ss format. This reads history only.

One provenance event with its full before/after attribute set.

Backed by GET /provenance-events/{id}.

Lineage graph for a flowfile, as nodes and links.

Backed by POST /provenance/lineage, polled to completion. Supply either flowfile_uuid or event_id.

NiFi Registry clients configured on this instance.

Backed by GET /controller/registry-clients.

Version-control state of a process group: registry, bucket, flow, and version.

Backed by GET /process-groups/{id}.

Flow counters and their current values.

Backed by GET /counters.