PRTG Manual: Maintainer Mode

Use the Maintainer Mode to pause and resume devices or check the status of devices without an active user session or user account.

Maintainer Mode Settings

Setting

Description

Maintainer Mode

Define if you want to enable Maintainer Mode:

  • Disable (default)
  • Enable

Access Key

This setting is only visible if you select Enable above. Shows the access key that you need for the API for authentication purposes.

i_round_blueThe access keys are URL friendly.

Generate new access key

This setting is only visible if you select Enable above. Enable the check box next to Generate new access key, click Save, and reload the page to generate a new access key.

Maintainer Mode API Endpoints and Parameters

You can execute the following actions by using the following endpoints:

  1. Query Device Status

Endpoint

Parameter

Description

\api\public\maintainer_querydevicestatus.htm

nodeid

Use this parameter to define the object ID of the device of which you want to query the status. Enter an integer value.

i_round_blueYou can find the object ID in the info box on the Overview tab of the device.

 

accesskey

Use this parameter to define the access key that you need for the API for authentication purposes. Enter a string.

Example

https://yourserver/api/public/maintainer_querydevicestatus.htm/nodeid=deviceID&accesskey=myaccesskey

  1. Pause Device

Endpoint

Parameter

Description

\api\public\maintainer_pausedevice.htm

nodeid

Use this parameter to define the object ID of the device of which you want to query the status. Enter an integer value.

i_round_blueYou can find the object ID in the info box on the Overview tab of the device.

 

accesskey

Use this parameter to define the access key for  key that you need for the API for authentication purposes. Enter a string.

 

name

Use this parameter to define a name for the user that pauses the device. Enter a string.

i_round_blueThe name appears in the status on the Overview tab of the device.

 

comment

Use this parameter to define a comment for the paused device. Enter a string.

i_round_blueThe comment appears in the status on the Overview tab of the device.

Example

https://yourserver/api/public/maintainer_pausedevice.htm?nodeid=deviceID&accesskey=myaccesskey&name=myname&comment=mycomment

  1. Resume Device

Endpoint

Parameter

Description

\api\public\maintainer_resumedevice.htm

nodeid

Use this parameter to define the object ID of the device of which you want to query the status. Enter an integer value.

i_round_blueYou can find the object ID in the info box on the Overview tab of the device.

 

accesskey

Use this parameter to define the access key for  key that you need for the API for authentication purposes. Enter a string.

 

name

Use this parameter to define a name for the user that resumes the device. Enter a string.

i_round_blueThe name appears in the log on the Log tab of the device.

Example

https://yourserver/api/public/maintainer_resumedevice.htm?nodeid=deviceID&accesskey=myaccesskey&name=myname

Setup

Others

There are some settings that you must make in the PRTG Administration Tool. For more details, see the sections: