Monitor internal APIs with runners

Private API Monitoring is available with Postman Basic, Professional, and Enterprise plans. To enable Private API Monitoring in your Enterprise team, contact your Postman Customer Success Manager.

With Private API Monitoring, you can use runners to monitor and test your organization’s APIs from your internal network, without publicly exposing your endpoints. Create a runner in your Postman team, then use the Postman CLI to set up the runner in your internal network.

Once set up, the runner securely polls Postman for monitor runs from your internal network, following your organization’s internal routing and access controls. Monitors run in your runner in your internal network and the runner sends the test results to the Postman cloud.

Configure a runner in your team

Create a runner to monitor and test your organization’s internal APIs. You can create a runner when you configure a monitor. With a Postman Enterprise plan, you can also create a runner from Runner settings. Once you start the runner from your internal network, your teammates can select the runner when creating monitors and check the health and performance of internal APIs from Postman.

Learn more at Configure runners for internal APIs.

Set up a runner in your restricted network

Once you’ve created the runner in your team, use the Postman CLI to set up the runner in your internal network. Get started by learning how to start and configure the runner. To set up the runner in your cloud network, such as a virtual private cloud, you can learn how to containerize the runner using Docker.

Learn more at Set up a runner in your restricted network.

Configure a runner to use a proxy server

For extra governance and security, you can configure your runner to use a proxy server that routes traffic and evaluates requests from the runner. If your organization has an existing proxy server, you can specify its URL when you start the runner. You can also use the built-in proxy server if you don’t want to create and maintain your own. To use the built-in proxy server, you only need to set up an authorization service with rules that decide which requests from the runner are allowed or blocked. If your proxy service or authorization service require custom CA certificates, you can also specify the path to the file.

Learn more at Set up a runner to use a proxy server.

Manage runners in your team

View and manage all of your team’s runners when you configure a monitor. You can view the commands for starting the runner with the Postman CLI, update your runners, delete runners you no longer need, and more. With a Postman Enterprise plan, you can also manage runners from Runner settings where you can view more details about your runners, like their health status.

Learn more at Manage runners for internal APIs.

Troubleshoot runners

To learn how to troubleshoot runners in your internal network, see Troubleshoot runners in Postman.