What is this?

This knowledgebase contains questions and answers about PRTG Network Monitor and network monitoring in general. You are invited to get involved by asking and answering questions!

Learn more

PRTG Network Monitor

Intuitive to Use. Easy to manage.
More than 500,000 users rely on Paessler PRTG every day. Find out how you can reduce cost, increase QoS and ease planning, as well.

Free Download

Top Tags


View all Tags

I want to use the new UI and new API. What do I need to know?

Votes:

2

Your Vote:

Up

Down

What do I have to do if I want to activate the new UI and new API of PRTG? What are the requirements? Where can I find frequently asked questions?

api prtg web-interface

Created on Oct 4, 2021 7:55:21 AM by  Florian Weik [Paessler Support]

Last change on Nov 5, 2021 1:22:57 PM by  Daniel Elsner [Paessler Support]



11 Replies

Votes:

0

Your Vote:

Up

Down

This article applies as of PRTG 21.4.73

The new UI and new API (Alpha) of PRTG

With PRTG 21.4.73 we introduced the first version of the new UI and new API (Alpha). The goal is to release a state-of-the-art web interface and RESTful API. In this article, you can find the available features, known issues, information about the activation of the new UI and new API (Alpha), the FAQ, and additional links about our plans.


Important: This is an alpha version with a limited set of features. For details, see 4. Available features


Content

  1. Disclaimer
  2. Limitations, requirements and known issues
  3. Activate the new UI and new API (Alpha)
  4. Available features
  5. Frequently asked questions (FAQ)
  6. More

Created on Oct 25, 2021 5:52:13 AM by  Florian Weik [Paessler Support]

Last change on Nov 19, 2021 12:36:59 PM by  David Keil [Paessler Support]



Votes:

0

Your Vote:

Up

Down

1. Disclaimer


Important: The new UI and new API are currently in the alpha phase. Unexpected issues can occur. We do not recommend that you activate the new UI and new API on your production system, especially if the system is connected to the internet.
If you still want to use the new UI and new API on your production system that is connected to the internet, we recommend that you block the ports that the new UI and new API use. You can find the respective ports in section Activate the new UI and new API (Alpha), Step 4.


Created on Oct 26, 2021 2:44:17 PM by  Florian Weik [Paessler Support]

Last change on Nov 8, 2021 8:56:34 AM by  Florian Weik [Paessler Support]



Votes:

0

Your Vote:

Up

Down

2. Limitations, requirements and known issues

2.1. Limitations

  • The alpha version is still missing important features. For a list of features, see Available features.
  • Clusters are currently not supported. If you run a cluster, the button does not appear after you activate the new UI and new API (Alpha).
  • The new UI and new API (Alpha) are not available for Paessler PRTG Hosted Monitor in the alpha phase.

2.2. System requirements

Activating the new UI and API starts an additional service which has a certain resource footprint. You do not need to take any extra precautionary steps if your installation follows the system requirements for PRTG which are laid out here. If your installation is already running considerably outside of these recommendations we suggest that you take a cautious approach to activating the new UI and API.

2.3. Known issues

  • Bug: Installations with a large amount of sensors and many user groups can cause increased memory consumption. This can cause the crash of the PRTG Application Server service. As a result the new UI and new API will be unavailable until the restart of the PRTG Application Server service.

2.4. Fixed known issues

  • With PRTG 22.1.74, we fixed the issue that the PRTG application server could not establish a connection to a PRTG core server if the PRTG core server did not use the default IP address. The PRTC core server now always allows connections from the PRTG application server via the default IP address 127.0.0.1:23580.
  • With PRTG 22.1.74, we fixed the issue that caused the Sensor Factory sensor to not receive measurements. The channels of the Sensor Factory sensor now receive measurements as expected again.
  • With PRTG 22.2.76, we fixed the issue that the path of a moved or cloned object was not updated properly. Objects that were moved or cloned now receive a correct update of their path.

Info: You can find comprehensive release notes for the new UI and new API here.

Created on Oct 26, 2021 2:45:13 PM by  Florian Weik [Paessler Support]

Last change on Apr 26, 2022 8:58:05 AM by  Florian Weik [Paessler Support]



Votes:

1

Your Vote:

Up

Down

3. Activate the new UI and new API (Alpha)

  1. Open the setup settings of PRTG. To do so, select Setup | Overview or enter the following URL http(s)://<yourprtgserver>/setup.htm.
  2. Find the Activate New UI And New API (Alpha) option on the bottom-right side and click Activate.Setting
    Click to enlarge.
  3. The activation dialog contains a link to this Knowledge Base article. Read the information in this article and the disclaimer carefully. Afterwards, enable the check box to confirm that you have read the disclaimer, and click OK to activate the new UI and new API (Alpha).Pop up
    Click to enlarge.

    Important: Make sure that port 8443 (HTTPS) or port 8080 (HTTP) and port 23580 (HTTPS and HTTP) are free.
  4. After the PRTG application server was installed and the PRTG core server was restarted, you can use the Open new UI button in the top-right corner to open the new UI, or enter the respective URL: http(s)://<yourprtgserver>:Port
    • The new UI and new API use the following port for secured connections: 8443
    • The new UI and new API use the following port for unsecured connections: 8080

To open Swagger, click Try out under the PRTG API v2 card on the new UI homepage or enter http(s)://<yourprtgserver>:Port/api/v2/oas/.

Created on Oct 26, 2021 2:51:33 PM by  Florian Weik [Paessler Support]

Last change on Mar 15, 2022 11:09:35 AM by  Florian Weik [Paessler Support]



Votes:

0

Your Vote:

Up

Down

4. Available features

The alpha versions of the new UI and new API currently include the following features:

  • Read: Probes, groups, devices, sensors, and channel data
  • Pause, Resume, Scan: Probes, groups, devices, sensors
  • Acknowledge: Sensors

Check the PRTG Release notes for newly added features.

Created on Oct 28, 2021 1:26:06 PM by  Florian Weik [Paessler Support]

Last change on Nov 5, 2021 6:46:28 AM by  Florian Weik [Paessler Support]



Votes:

0

Your Vote:

Up

Down

5. Frequently asked questions (FAQ)

5.1 What are the new UI and new API of PRTG?

The new PRTG web interface (new UI) is the redesign of the PRTG web interface based on user research. The new UI will be fully responsive and will work on every screen size. We are working hard on following the Web Content Accessibility Guidelines (WCAG) and ensuring that PRTG is accessible to as many people as possible.

The PRTG API v2 (new API) is the new RESTful API of PRTG. The goal of the new API is to enable you to easily automate your monitoring and to integrate it with other tools. The new API is comprehensively documented and consistent across all endpoints.

5.2 What does alpha release mean?

The alpha release of the new UI and new API only offers a limited set of features and is not yet stable. You can find a list of features here: Available features.

5.3 Why release the alpha of the new UI and new API now?

We decided to release the alpha version to give our users the opportunity to try out the new UI and new API and to gather feedback during the early development process. We want to build exactly what our users need and implement the features based on the priority for our users.

5.4 Why is the alpha release missing important features, for example charts or the ability to create or edit objects?

The alpha version is an early testing version. We will gradually add more features. Check the PRTG Release notes for newly added features.

5.5 Do you plan to deactivate the classic PRTG web interface and API (v1) soon?

We plan to deactivate the classic PRTG web interface and API (v1) once the new UI and new API are stable and feature complete. We will communicate the period for the deactivation with advance notice.

5.6 What happens if I activate the new UI and new API in my PRTG installation?

If you activate the new UI and new API, an additional service called PRTG Application Server will be installed. For more information, see question 5.7 "What is the PRTG application server?" below.

After the activation, the classic PRTG web interface and the new UI as well as the PRTG API (v1) and the PRTG API v2 are available side by side. If the network and firewall rules allow it, users can access them via different ports.

5.7 What is the PRTG application server?

The PRTG application server is the service that delivers the new UI and new API. After the installation of the PRTG application server, PRTG automatically creates the Application Server Health (Autonomous) sensor that helps you to monitor the status of your PRTG application server.

5.8 Should I activate the new UI and new API (Alpha) on my production system?

The new UI and new API are currently in the alpha phase. Unexpected issues can occur. We do not recommend that you activate the new UI and new API on your production system, especially if the system is reachable from the internet.

If you activate the new UI and new API, an additional service called PRTG Application Server will be installed. For more information, see question 5.7 "What is the PRTG application server?" below.

5.9 Does the new PRTG application server support the same Transport Layer Security (TLS) and cipher configurations as the PRTG web server?

The PRTG application server honors the connection security settings that are configured under Setup | System Administration | User Interface in section PRTG Web Server in the classic PRTG web interface.

However, the TLS versions that are included in the different security settings slightly differ from the settings of the PRTG web server. These are the TLS versions that the PRTG application server offers:

  • High security (TLS 1.3)
    • For comparison:
      • PRTG Web Server Settings: High security (TLS 1.2)
  • Default security (TLS 1.2 and TLS 1.3)
    • For comparison:
      • PRTG Web Server Settings: Default security (TLS 1.2)
  • Weakened security (TLS 1.0, TLS 1.1, TLS 1.2, and TLS 1.3)
    • For comparison:
      • PRTG Web Server Settings: Weakened security (SSLv3, TLS 1.0, TLS 1.1, TLS 1.2)

Note: If you have set a registry key to override the Secure Sockets Layer (SSL)/TLS version and cipher suites of PRTG web server connections, these settings do NOT apply to the PRTG application server.

5.10 Does the PRTG application server support custom SSL certificates?

Yes, the PRTG application server uses the same certificate as the PRTG web server. To use your own SSL certificate, move the certificate file to the \cert subfolder in the PRTG program directory. For more information, see PRTG Manual: Using Your Own SSL Certificate with the PRTG Web Server.

5.11 Does Paessler PRTG Hosted Monitor support the new UI and new API?

The new UI and new API are not available for Paessler PRTG Hosted Monitor in the alpha phase. Check the PRTG Release notes regularly to find out once the new UI and new API are available for Paessler PRTG Hosted Monitor.

5.12 Can I use the new UI and new API if I run a cluster?

The new UI and new API do not yet support PRTG installations that run in cluster mode. We plan to change this in the future. Check the PRTG Release notes regularly to find out once the new UI and new API are available for PRTG installations that run in cluster mode.

5.13 Can I hide the “Activate New UI And New API (Alpha)” banner in PRTG?

Yes, to globally hide the banner, follow the instructions here.

5.14 How can I deactivate the new UI and API?

You can deactivate the new UI and API via the PRTG web interface or the PRTG Administration Tool.

PRTG web interface:

  1. Open the setup settings in the PRTG web interface. To do so, select Setup | Overview in the global header area or enter the following URL http(s)://<yourprtgserver>/setup.htm.
  2. Find the Deactivate New UI And New API (Alpha) option on the bottom-right side and click Deactivate.
  3. In the dialog that appears, click OK.

PRTG Administration Tool:

  1. Open the PRTG Administration Tool on the PRTG core server system.
  2. Navigate to tab PRTG Application Server.
  3. Click Uninstall Service.

Created on Nov 2, 2021 2:43:09 PM by  Florian Weik [Paessler Support]

Last change on May 13, 2022 12:07:44 PM by  Florian Weik [Paessler Support]



Votes:

0

Your Vote:

Up

Down

6. More

6.1 PRTG Roadmap

If you want to know what we are working on right now, check the PRTG Roadmap.

6.2 Feedback form and survey

Please share your experience with the new UI and new API with us here.

You can also participate in the New API for PRTG survey here.

6.3 Video tutorials

See also our video tutorials about the new UI and new API:

PRTG tutorial new user interface
Click to watch video.

PRTG tutorial new API
Click to watch video.

6.4 API documentation

You can find the API overview here.

You can find an API reference documentation with all of the available endpoints here.

Created on Nov 3, 2021 6:59:01 AM by  Florian Weik [Paessler Support]

Last change on Nov 19, 2021 11:41:47 AM by  David Keil [Paessler Support]



Votes:

0

Your Vote:

Up

Down

Where is the SSO function on the login to new interface? This seriously needs adding ASAP. We enabled it then realised this and have since not used it at all.

Created on Jan 21, 2022 6:00:11 AM by  AuRiSmith (90)



Votes:

0

Your Vote:

Up

Down

Hi Richard,

Since we are still working on the new web interface, we will add this feature in future.


Kind regards

Felix Wiesneth - Team Tech Support

Created on Jan 21, 2022 8:50:43 AM by  Felix Wiesneth [Paessler Support]



Votes:

0

Your Vote:

Up

Down

I do not see this option on my install even though I am past the version mentioned.

Created on Apr 13, 2022 10:00:35 PM by  pcookhayboo (0)



Votes:

1

Your Vote:

Up

Down

Hello Peter,

Are logged in with an administrator account? Please double-check if you are in the latest version available of PRTG. If the issue persists and/or you have more questions to the new UI, don't hesitate to contact us via [email protected] .


Kind regards

Felix Wiesneth - Team Tech Support

Created on Apr 14, 2022 6:08:55 AM by  Felix Wiesneth [Paessler Support]



Please log in or register to enter your reply.


Disclaimer: The information in the Paessler Knowledge Base comes without warranty of any kind. Use at your own risk. Before applying any instructions please exercise proper system administrator housekeeping. You must make sure that a proper backup of all your data is available.