[postman] the monitors monitoring API can run periodically

Postman Monitors So that you can continue to understand API Health and performance . Setting up a new monitor is simple and flexible . Quickly create uptime monitors （ Open beta ） To monitor individual API Endpoint . Or create a collection based monitor to run API The test script 、 Link multiple requests together and verify key API flow .

Monitors After operation , You will receive an alert of any system interruption or test failure , So you can go to API Identify and solve problems before users are affected .

establish Monitors

Create uptime Monitors

Create a new uptime monitor to track individual API Endpoint 、 Website or other URL The usability of . Whenever a shutdown is detected or the service is restarted and available , The uptime monitor will send email notifications to your team .

1. Select monitor in the sidebar , And then choose +.

2. In the right pane, select Create uptime monitor .

3. Enter what you want to monitor URL . What you want to monitor URL、API Endpoint or website must be in Internet Publicly available on . Support HTTP and HTTPS agreement .

4. about Monitor name, Enter a descriptive name , To help you identify the monitor later .

5. Configure any optional details for the monitor ：

   • Notification recipient - Add up to five Postman Team members , In order to receive notification in case of shutdown .
   • Operating frequency - Select monitor check URL Frequency of availability , At most every minute （ Payment plan ） Or every 15 minute （ Free program ）.
   • region - Select one or more regions to run the monitor （ Payment plan ）. If a shutdown occurs in any selected area , A notification will be sent .（ For free programs , The area will be automatically selected .）
   • Follow redirection - Select this option to exclude redirection from service downtime .

6. Select Create uptime monitor .

Check the uptime monitoring results

To view the results of the uptime monitor , Please select the monitor in the sidebar , Then select a monitor to view its dashboard .

The dashboard shows API Is the endpoint open or closed at the last check 、 How long did it last and the number of failed areas . To update the dashboard with the latest monitor status , Please select the refresh icon refresh Icon .

The dashboard also displays key statistics for the selected time period . You can view the average percentage of time that the terminal node is available in at least one area . You can also view the number of downtime events and the average response time （ In Milliseconds ）. To change the displayed time period , Please select different time periods in the menu in the upper right corner .

Check the uptime graph

The uptime graph shows the monitored endpoints during the selected time period URL The state of ：

Up -（ green ）URL Processing traffic and at expected response time （60 Seconds or less ） Back inside 2xx The status code .

close -（ Red ） The URL No flow is provided 、 Return non 2xx The status code may exceed the expected response time （ exceed 60 second ）.

If you selected the follow redirection option when configuring the monitor , be 3xx Status codes are not considered downtime .

Unknown - （ gray ） The postman is not sure URL The state of , Because the monitor has paused , Because the monitor does not exist in the displayed time period , Or for some other unexpected reason .

Select summary to view combined data for all areas , Or select areas to view data for each area .

View downtime events

All detected interrupts are listed under shutdown events . For each event , The list will show the start time 、 The duration of the 、 Error codes and affected areas .

Use the uptime monitor

In the monitoring dashboard , You can do the following ：

Pause the uptime monitor - When suspended , The monitor no longer calls the specified URL. To pause the monitor , Please select More action icons More action icons in the upper right corner , Then select pause . To restore the monitor , please More action icons Select the more actions icon again and select recover .

Edit uptime monitor - Edit the existing uptime monitor to update the name 、URL Or any other configuration options . More action icons Select the more actions icon in the upper right corner , Then choose Edit . Change any configuration options , Then select Update Monitor .

You can rename the monitor without editing . Select monitor in the sidebar , Select the more actions icon next to the monitor More action icons , Then select Rename .

Delete uptime monitor - If the uptime monitor is no longer needed , Please delete it . More action icons Select the more actions icon in the upper right corner , Then select Delete .

Receive notification of downtime

You can connect the uptime monitor with Slack Integrate to get real-time notifications . After setting integration , You will choose Slack A shutdown alarm is received in the channel . When the downtime ends , You will also be notified .

1. From the uptime monitor dashboard , Select notification .

2. choice Slack External link icon Next to the external link icon .

3. Choose to continue logging in to your Slack work area . View the requested permissions and select allow . After completion , Close the browser tab to continue using Postman.

4. Enter a nickname to help you identify the integration .

5. Choose to be in Slack Uptime monitor for getting notifications in .

6. Select the Slack channel .

7. Select Add integration .

To edit or delete Slack Integrate , Please select notification from the uptime monitor dashboard , Then select the edit icon Edit icon Or delete the icon Delete icon .

Uptime monitor pricing

pay Postman The planned team can try the uptime monitor for free . During the public beta , You can have up to three （ Basic plan ）、 Five （ Professional plan ） Or nine （ Business plan ） Uptime monitor , Including suspended monitors . These free uptime monitors are not included in your team's monitoring API Monthly usage limit of calls .

Postman Free Scheduled users can also try the uptime monitor . You can create up to three uptime monitors for free . please remember , Calls from these monitors will be credited to your team every month 1,000 Secondary monitoring API Call limit . If you need to make more calls , You can upgrade your Postman Plan or purchase additional monitoring blocks .

Normal operation time Monitors

Uptime monitor （ Open beta ） It's easy to track API Or website availability . There is no need to set the set 、 Test script or environment . Enter what you want to monitor URL（ Limited to HTTP or HTTPS） And select the team member to notify of the interruption .

The uptime monitor every other minute （ Payment plan ） Or every 15 Minutes at a time （ Free program ） Continuous inspection URL The usability of . Once downtime is detected , Selected team members will receive alerts via email .

The uptime monitor ensures your API Or the service is available 24 / 7 , And help you detect system interruption problems faster . The uptime statistics are recorded on the dashboard of the monitor , So you can check it at any time API The state of 、 Check past trends or pause the monitor as needed .

Set based Monitors

The collection based monitor runs according to the schedule you set from Postman A series of requests from the cloud . When creating a monitor , You can choose the set that contains the request to run . These can be basic requests that indicate whether the endpoint is started and accessible . More complex collections can take advantage of chained requests 、 Test scripts and environment variables to verify API Response and function .

You can according to your Postman Plan to configure the monitor to run as often as possible . For payment plans , The monitor can be scheduled to run every five minutes . For free programs , The monitor can be scheduled to run every hour . You can even specify which part of the world you want to run the series from （ Pay plan only ）.

If the test fails or an error occurs , Will receive an alert via email , Or set up integration to pass Slack And other channels for notification . All results are recorded on the dashboard of the monitor , So you can view past results or trends over time .

Learn how to set up a collection based monitor .

Add request timeout

If you want to ensure that all requests run within a certain time , You can choose to set the request timeout . By default , The request has no timeout , But each monitor runs with a five minute timeout . Cannot configure at request level .

The request timeout must not exceed five minutes （300000 millisecond ）.

Use cases

Because they run Postman Requests and scripts , So collection based monitors can be used to monitor in many ways API. Here are some actions you can perform with a collection based monitor ：

Check API Health and performance - Make sure API Start and run in production and other environments .
verification API Response structure and data - Make sure API Operate according to specifications .
Test complex multi-step workflow - Ensure key API Process and edge cases work as expected .
Continuous user acceptance 、 Smoking and regression testing - Actively identify problems , So that you can influence API Users solve them before .
Run tests in multiple environments and regions - Make sure your API It works well anywhere .（ Running monitors in multiple areas requires a fee Postman plan .）
Monitor endpoint security - Keep testing API To find known security vulnerabilities .
Visualize the results on the monitor dashboard - Better understand as time goes on API Performance and identify trends .

Summary

Monitors for general scale api There is not much benefit in terms of quantity .>100 At the heart of api The best service is for charging. It's necessary to use tools to guarantee it . However, there are many tools in the backstage service to ensure service . This may not be the best cost performance . For information only