<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: System Information

You can access live data and live status data for system information using the PRTG API.

Authentication with username and passhash (or username and password) must always be included in each PRTG API request. See section Authentication for more information.

To retrieve system information using API calls, we recommend that you use the following order:

1. Refresh the system information so that it is up to date, if necessary.
   For details, see System Information—Scan Now.
2. Retrieve generic system information to ensure that the last scan (step 1) was successful and that there are no errors.
   For details, see System Information—Generic Data.
3. Retrieve system information in the form of data tables.
   For details, see System Information—Data Tables.

System information API calls only support the JavaScript Object Notation (JSON) output.

System Information—Scan Now

The following API calls to retrieve new information for a system information category. To refresh system information via the API, you need to provide

• the ID of a device (parameter id), and
• a kind (system information category).

We recommend that you only refresh system information if absolutely necessary because the refresh triggers a rescan of all system information tables.

Supported Output Columns ("kind=" Parameter)

System Information—Generic Data

The following API calls retrieve generic data about the system information category since the last scan, for example time stamps and if the last scan was successful. To retrieve this information via the PRTG API, you need to provide

• the ID of a device (parameter id), and
• a kind (system information category).

System Information—Data Tables

The following API calls retrieve all information from a system information category table. To retrieve this information via the PRTG API, you need to provide

• the content type (always sysinfo),
• the category (as displayed in the PRTG web interface),
• columns (see System Information—Supported Output Columns ("columns=" Parameter)), and
• the ID of a device (parameter id).

System Information—Supported Output Columns ("columns=" Parameter)

You can use the following sysinfo-specific column names for the columns parameter (separated by comma, for example, columns=_key,_value).

For a list of all supported column names, see section Multiple Object Property or Status.

More

KNOWLEDGE BASE

How can I use the PRTG Application Programming Interface (API)?

• https://kb.paessler.com/en/topic/593

Application Programming Interface (API) Definition—Topics

• HTTP API
• Live Data

• Single Object Property
• Single Object Status
• Multiple Object Property or Status
• System Information

• Live Graphs
• Historic Data
• Object Manipulation
• Custom Sensors
• Custom Notifications
• Mini Probe API