Manage runners for internal APIs

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.

As a Team Admin or Super Admin, you can view and manage runners when you configure a monitor. This enables you to view all of your team’s runners in one place. You can view the Postman CLI commands again for setting up each runner in your internal network, update each runner’s name and description, and delete runners you’re no longer using. You can also reset a runner key for a runner if you it.

With a Postman Enterprise plan, you can also view and manage runners from Runner settings. You can view more details about your runners, like the health status of each runner.

Manage runners

To view and manage runners when you configure a monitor, do the following:

1. Click Monitors in the sidebar, then create or edit a monitor.

2. Under Runners, click next to a runner, then select the following:

   • Install - Get the commands for setting up the runner in your internal network, including the runner ID.
   • Edit - Update the runner’s name and description. Click Save to confirm your changes.
   • Delete - Delete a runner. Click Delete Runner to confirm.

   

3. (Enterprise plans only) Hover over the runners icon next to each runner’s name to view its health status and last ping date and time. The runners icon also has a colored dot that shows whether a runner has sent test results to the Postman cloud, providing insight about the health status of the runner:

   • Healthy - A green dot means the runner recently sent results.
   • Unhealthy - An orange dot means the runner hasn’t recently sent results.
   • Unknown - A gray dot means the runner hasn’t sent results yet.

4. (Optional) Continue configuring your monitor.

Manage runners from Runner settings

Runner settings is available with Postman Enterprise plans only. To enable Private API Monitoring in your Enterprise team, contact your Postman Customer Success Manager.

View and manage your team’s runners from Runner settings. Select Team > Team Settings in the Postman header then select Runners in the left sidebar.

From Runner settings, you can review each runner’s name, health status, last ping date and time, workspace visibility, creator, creation date, and modified date. Search by runner name, filter by health status in the Status dropdown list, and filter by user in the Created by dropdown list. You can also click a runner’s name to view more details about a specific runner, such as the runner key’s last generated date.

Hover over the runners icon next to each runner’s name to view its health status and last ping date. The runners icon also has a colored dot that shows whether a runner has sent test results to the Postman cloud, providing insight about the health status of the runner:

• Healthy - A green dot means the runner recently sent results.
• Unhealthy - An orange dot means the runner hasn’t recently sent results.
• Unknown - A gray dot means the runner hasn’t sent results yet.

You can also click next to a runner to take additional actions:

• Install - Get the commands for setting up the runner in your internal network, including the runner ID.

• Edit - Update the runner’s name, description, and workspace visibility.

  • Update internal workspaces where the runner is visible. Select one of the following:

    • All internal workspaces in team - The runner is visible in all internal workspaces in your team.

    • Selected workspace - Click the Select workspace dropdown list and then select the internal workspace where the runner is visible.

      You can change this later when you’re ready to make the runner visible in all your team’s internal workspaces.

  • Click Save to confirm your changes.

• Delete - Delete a runner. Click Delete Runner to confirm.

View details about a specific runner

From Runner settings, you can click a runner’s name to view more details about a specific runner:

• Status - Whether the runner has sent test results to the Postman cloud.

  • Healthy - The runner recently sent results.
  • Unhealthy - The runner hasn’t recently sent results.
  • Unknown - The runner hasn’t sent results yet.

• Latest ping - The last date and time the runner sent results to the Postman cloud.

• Created by - The teammate who created the runner.

• Created on - The date the runner was created.

• Modified on - The date the runner was last modified.

• Last key generated at - The date the runner key was last generated.

• Visibility - The internal workspace where the runner is visible.

• Current jobs in queue - The number of monitors waiting to run in the runner.

• Oldest queued job age - The age of the monitor (in seconds) that has been waiting the longest to run in the runner.

Click Instances to view all instances of the runner polling Postman for upcoming monitor runs:

• Hostname - The hostname of the machine where the runner instance is running.
• Unique ID - The unique ID associated with the runner instance.
• CLI Version - The version of the Postman CLI used to start the runner instance.
• OS Type - The operating system of the machine where the runner instance is running.
• Last Pinged - The last date and time the runner instance sent results to the Postman cloud.

Click Install in the upper right to get the commands for setting up the runner in your internal network, including the runner ID.

You can also click next to a runner to edit or delete it:

• Edit - Update the runner’s name, description, and workspace visibility.

  • Update internal workspaces where the runner is visible. Select one of the following:

    • All internal workspaces in team - The runner is visible in all internal workspaces in your team.

    • Selected workspace - Click the Select workspace dropdown list and then select the internal workspace where the runner is visible.

      You can change this later when you’re ready to make the runner visible in all your team’s internal workspaces.

  • Click Save to confirm your changes.

• Delete - Delete a runner. Click Delete Runner to confirm.

Reset a runner key

If you lose your runner key, you can reset it when you configure a monitor or from Runner settings.

To reset a runner key, do the following:

1. Click next to a runner then select Install. If you’re viewing more details about a specific runner in Runner settings, click Install in the upper right.
2. Click Reset Runner Key.
3. Click Copy to clipboard to copy the runner command with the new runner key.
4. If the runner is running in your internal network, update the command to use the new runner key.