System

System information and diagnostics

For system and cluster level functions interacting with the underlying NiFi Services

nipyapi.system.get_cluster()[source]

EXPERIMENTAL Returns the contents of the NiFi cluster

Returns (json):

nipyapi.system.get_nifi_version_info()[source]

Returns version info for the connected NiFi instance.

  • In 2.x, the non-privileged About endpoint is used first.

  • For backward compatibility with callers expecting a VersionInfoDTO, we return a VersionInfoDTO with only ni_fi_version set when About succeeds.

  • If About is unavailable, fall back to system diagnostics DTO.

Returns (VersionInfoDTO):

nipyapi.system.get_node(nid)[source]

Returns the cluster node information

Parameters:

nid (str) – The UUID of the Node to target

Returns:

nipyapi.system.get_registry_version_info()[source]

Returns the version information of the connected NiFi Registry instance.

Uses About endpoint which is sufficient for version probes. Returns (str): The version string (e.g., “2.5.0”)

nipyapi.system.get_system_diagnostics()[source]

Returns NiFi Sytems diagnostics page

Returns (json):