GETINFO

GETINFO is a command in the Tor control protocol used to retrieve information about a running Tor process. It allows a controller, such as an administrative tool or monitoring script, to query runtime state, status, and configuration without changing any settings. GETINFO is issued over an authenticated control connection and can request one or more information items in a single command.

When invoked, GETINFO returns data in a structured, human-readable form. The response typically consists of lines containing information as key/value pairs or blocks of related data, followed by a success status from the Tor process. The exact format may vary by Tor version, but the command is designed to be extensible, enabling controllers to fetch a wide range of runtime data.

Common information categories queried with GETINFO include the Tor version, bootstrap phase, uptime, network listener endpoints, circuit and path status, and various runtime settings currently in effect. Examples of typical queries are GETINFO version to obtain the software version, GETINFO status/bootstrap-phase to monitor startup progress, and GETINFO net/listeners or GETINFO circuit-status to inspect active network endpoints or circuits. Controllers may request multiple items in a single call to reduce round trips.

Security and usage notes: GETINFO requires authentication on the control port. Access to certain information may be restricted by policy or by controller permissions. GETINFO is a read-only command intended for monitoring, diagnostics, and automation, and is commonly used alongside other control commands such as AUTHENTICATE and GETCONF.