- Installation and updates
- Sending your first request
- Navigating Postman
- New button
- Creating the first collection
- Postman account
- Keyboard Shortcuts
- Troubleshooting In-app Issues
- Authorizing requests
- Working with Tabs
- Visualize API responses
- Validating Requests Against Schema
- Generate code snippets
- Using GraphQL
- Making SOAP requests
- Capturing HTTP requests
- Debugging and logs
- Troubleshooting API requests
- Intro to collections
- Creating collections
- Sharing collections
- Commenting on collections
- Managing collections
- Version Control for Collections
- Using Markdown for descriptions
- Data formats
- Working with OpenAPI
- Collaborating in Postman
- Roles and permissions
- Managing your team
- Requesting access
- Team Settings
- Audit logs
- Intro to scripts
- Pre-request scripts
- Test scripts
- Test examples
- Branching and looping
- Postman Sandbox
- Postman Sandbox API reference
- Intro to collection runs
- Starting a collection run
- Using environments in collection runs
- Building workflows
- Running multiple iterations
- Sharing a collection run
- Working with data files
- Debugging a collection run
- Command line integration with Newman
- Integration with Jenkins
- Integration with Travis CI
- Newman with Docker
- Documenting your API
- Authoring your documentation
- Publishing your docs
- Viewing documentation
- Custom documentation domains
- Intro to mock servers
- Setting up a mock server
- Mocking with examples
- Mocking with the Postman API
- Matching algorithm
- Intro to Monitoring
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Running Postman monitors using static IPs
- Troubleshooting monitors
- FAQs for monitors
- Intro to Workspaces
- Creating Workspaces
- Using Workspaces
- Managing Workspaces
- Viewing changelogs and restoring collections
- The API Workflow
- Managing and Sharing APIs
- Versioning APIs
- Viewing and analyzing APIs
- Validating Elements Against Schema
- Customizing Postman
- Find and Replace
- Purchasing Postman
- Intro to SSO
- Configuring SSO for a team
- Logging in to an SSO team
- Configuring Microsoft AD FS with Postman SSO
- Setting a custom SAML in Azure AD
- Setting up custom SAML in Duo
- Setting up custom SAML in GSuite
- Setting up custom SAML in Okta
- Setting up custom SAML in Onelogin
- Setting up custom SAML in Ping Identity
- Intro to Integrations
- Custom Webhooks
- Microsoft Flow
- Microsoft Teams
- Publishing API documentation
Intro to Monitoring
Postman Monitoring helps you to stay up to date on the health and performance of your APIs. Within a matter of seconds, you can set up Postman's monitoring service and integrate it into your API development pipeline.
- What is monitoring?
- Monitor dashboard
- Next steps
Monitoring is a way to stay up to date on the health and performance of your APIs. Postman's built-in monitoring service helps you consolidate an additional step in your API development lifecycle.
Postman monitors are based on collections. Monitors can be scheduled as frequently as every five minutes and will run through each request in your collection, similar to the collection runner. You can also attach a corresponding environment with variables you'd like to utilize during the collection run.
The value of monitors lies in your test scripts. When running your collection, a monitor will use your tests to validate the responses it's receiving. When one of these tests fail, you can automatically receive an email notification or configure the available integrations to receive alerts in tools like Slack, PagerDuty, or HipChat.
You can use Postman monitoring with any paid or free plan type.
You can find your account type's usage limits by referring to your usage overview.
With a free Postman account, once you've reached your usage limit for monitoring you'll be automatically capped for the remainder of your monthly cycle. To continue to use monitoring for the remainder of your cycle, you can upgrade your Postman plan.
With a paid Postman account, you have the option to cap your monthly monitoring usage by navigating to your billing dashboard > Overages and deselecting Allow monitoring overages. Overages are allowed by default and are charged at a pay-as-you-go rate. You can also opt to purchase monitoring blocks.
Unused monitoring requests or blocks do not roll over and must be consumed during the month purchased.
See more on how Postman calculates usage.
This page allows you to view your team's current billing period, how many requests have been made, and which monitors have run. It also identifies monitors by name, collection, environment, and creator, and provides a breakdown of requests made by each monitor.
If you are concerned about or are surprised by overages, this is the place to go to find all of your team's active monitors in one place, plus information to help you and your team make informed decisions on items like monitoring frequency.
Postman calculates monitoring usage based on the actual number of requests made during a run, which may or may not be equal to the number of requests in your collection.
If you use
postman.setNextRequest() to skip a request or run a request multiple times, Postman will take that into account when calculating usage. Postman will also count any requests required for authorization.
There are a few differences between running collections in a Postman monitor and running them via the in-app collection runner, so take note of the following.
- You cannot import existing global variables to a monitor, but you can create new ones during a run.
Global and environment variables can be updated and subsequently used during a monitoring run, however they will immediately revert to their original values, unlike in the collection runner when persist variables is enabled.
- If you require persistent variables, you can add a call to update your environment using the Postman API.
- For your security and privacy, Postman does not log request or response bodies in the console.
- Postman will also not log headers, as they may include items like cookies and authorization keys.
- Runs are limited to five minutes, including all HTTP requests, responses, pre-request, and test scripts.
- You cannot attach files to requests, unlike in the request builder, however you can upload data as a raw request body.
- You cannot attach data files, unlike in the collection runner, but you can access them via APIs, including Google Docs, Google Sheets, and Dropbox.
- Monitors only run one iteration by default, but you can use setNextRequest() to run multiple iterations.
- When setting up or editing a monitor, you can select multiple geographic regions you'd like your monitor to run from, or opt to auto-select a region.
If you’re interested in a region that’s not listed in the Postman interface, contact the Postman support team.
- Monitors require all URLs to be publicly available on the internet as they run in the Postman cloud. A monitor cannot directly access your localhost or run requests behind a firewall. However, to overcome this issue, static IPs are available on Postman Business and Enterprise plans.
Each workspace has its own monitor dashboard, which you can navigate to by visiting your web dashboard, selecting a workspace > Monitors.
This dashboard provides a high-level overview of the monitors you have available in your workspace, including status, success rate, and average response time.
Hovering over a monitor in the list allows you to run it outside of its predetermined schedule by clicking ▶. To pause, resume, edit, and delete monitors, select the ... icon.