PRTG Manual: API Keys

On the API Keys tab, you can add, edit, and delete API keys that are specific to the user account.

i_round_blueThis documentation refers to an administrator that accesses the PRTG web interface on a master node. Other user accounts, interfaces, or failover nodes might not have all of the options in the way described here. In a cluster, note that failover nodes are read-only by default.

i_podIf 15 minutes (900) seconds have passed since your last credential-based login and you open a setup page from a different setup page, PRTG asks you to enter your credentials again for security reasons. A dialog box appears. Enter your Login Name and Password and click OK to continue.

API Keys Overview

Click the API Keys tab to show a list of all API keys for the user account. You have the following options:

Option

Description

Edit (b_template_edit)

Open the settings of the API key and change its name, description, and access level.

Delete (b_template_delete)

Delete the API key.

i_round_blueYou can select and delete multiple API keys at once using multi-edit.

Add API Key

Hover over b_add and select Add API Key or Add API Key for PRTG MultiBoard from the menu to add a new API key.

Add new API key

Add new API key

Setting

Description

Name

Enter a name to identify the API key.

i_round_blueIf the name contains angle brackets (<>), PRTG replaces them with braces ({}) for security reasons. For more information, see the Knowledge Base: What security features does PRTG include?

Description

Enter a description for the API key.

Token Type

Shows the type of token:

  • Scripting: Use this token with the PRTG API and API v2.
  • Desktop: Use this token with PRTG MultiBoard. You can only have one API key of this type per user.

i_round_blueThis setting is for your information only. You cannot change it.

Access Level

Select the access level for the API key:

  • Read access
  • Acknowledge access
  • Write access
  • Full access

i_round_blueFor more information about access rights in PRTG, see section Access Rights Management.

API Key

Shows the token.

i_round_blueCopy and store this token. After you click OK, the token will not be visible again.

i_round_blueThis setting is for your information only. You cannot change it. If you lose it, you should remove the API key and create a new one.

Click OK to save your settings, or click Cancel to close the dialog box without creating an API key.

Edit API Key

Edit API Key

Edit API Key

After creation, you can edit the name, the Name, the Description, and the Access Level of your API keys.