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:
|
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.
|
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:
- 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.
|
|
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
- 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.
|
|
accesskey |
Use this parameter to define the access 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.
|
|
comment |
Use this parameter to define a comment for the paused device. Enter a string.
|
Example
https://yourserver/api/public/maintainer_pausedevice.htm?nodeid=deviceID&accesskey=myaccesskey&name=myname&comment=mycomment
- 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.
|
|
accesskey |
Use this parameter to define the access 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.
|
Example
https://yourserver/api/public/maintainer_resumedevice.htm?nodeid=deviceID&accesskey=myaccesskey&name=myname
There are some settings that you must define in the PRTG Administration Tool. For more information, see sections:
