How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Postman Monitors API

The Monitors API runs Postman Collections on a recurring schedule to validate API health, performance, and contract conformance. Surfaces metrics, test results, and notification webhooks for incident response.

Postman Monitors API is one of 43 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Automation, Monitoring, Scheduling, Testing, and Observability. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

This API exposes 8 operations across 5 paths, and defines 89 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.postman.com, https://api.eu.postman.com.

8 operations 5 paths 89 schemas 1 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.getpostman.com
Authentication
API Key, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 3

Postman Monitors API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (PostmanApiKey). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (scimApiKey).

  • scimApiKey — A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/generating-scim-api-key) for calls to SCIM…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Monitors 8
GET
/monitors
Get all monitors
getMonitors 8 params → 200400401403404500
POST
/monitors
Create a monitor
createMonitor 2 params body → 200400401403500
GET
/monitors/{monitorId}
Get a monitor
getMonitor 2 params → 200401403404500
PUT
/monitors/{monitorId}
Update a monitor
updateMonitor 2 params body → 200400401403404500
DELETE
/monitors/{monitorId}
Delete a monitor
deleteMonitor 2 params → 200401403404500
POST
/monitors/{monitorId}/run
Run a monitor
runMonitor 3 params → 200401403404500
GET
/runners/{runnerId}/instances
Get all runner instances
getRunnerInstances 4 params → 200400401403404500
GET
/runners/{runnerId}/metrics
Get runner metrics
getRunnerMetrics 2 params → 200401403404500

Schemas 89

The contract defines 89 schemas that model the data the API accepts and returns. The most detailed are GetMonitorMonitor (15 properties), CreateMonitorMonitor (10 properties), monitorRunInfo (8 properties), UpdateMonitorMonitor (8 properties). Each schema is shown below with its type and property counts.

commonErrorTypeTitleDetail
object
3 properties
MonitorRunStatsRequests
object
Information about the monitor's requests.
2 properties
GetRunnerInstancesRequestInternalServerError
createMonitor
object
1 property
MonitorNotificationsOnFailureItems
object
1 property
monitorLastRun
object
Information about the monitor's previous run.
4 properties
RunMonitorRun
object
Information about the monitor run. If you pass the async=true query parameter, the response does not return the stats, executions, and failures responses. To g…
4 properties
RunMonitorRequestForbiddenError
UpdateMonitorRequestForbiddenError
CreateMonitorRequestInternalServerError
CommonErrorNameMessageDetailsErrorDetails
Information about the error.
GetMonitorMonitorSchedule
object
Information about the monitor's schedule.
3 properties
GetMonitorsRequestUnauthorizedError
UpdateMonitorRequestInternalServerError
monitorSchedule
object
Information about the monitor's schedule.
2 properties
monitorOptions
object
Information about the monitor's option settings.
4 properties
UpdateMonitorRequestUnauthorizedError
CreateMonitorRequestBadRequestError
updateMonitor
object
1 property
runnerErrorTypeTitleDetailCreatedAt
object
4 properties
CreateMonitorMonitor
object
Information about the monitor.
10 properties 3 required
runMonitor
object
1 property
monitorRunExecutions
array
Information about the monitor run's executions.
CreateMonitorRequestUnauthorizedError
RunMonitorRunFailuresItems
object
GetMonitorsRequestBadRequestError
DeleteMonitorRequestInternalServerError
commonErrorNameMessageDetails
object
1 property
GetRunnerMetricsRequestForbiddenError
collectionUidQuery
string
monitorNotifications
object
Information about the monitor's notification settings.
2 properties
cursor
string
RunMonitorRequestInternalServerError
runnerId
string
GetMonitorMonitor
object
Information about the monitor.
15 properties
monitorRunErrors
array
If the execution encounter errors, a list of errors and their information.
CommonErrorTypeTitleDetailStatusType
owner
integer
getMonitor
object
1 property
GetRunnerInstancesRequestForbiddenError
MonitorRunExecutionsItems
object
5 properties
monitorRetry
object
Information about the monitor's retry settings.
1 property
GetRunnerMetricsRequestInternalServerError
monitorDistribution
array
A list of the monitor's [geographic regions](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/add-regions).
GetMonitorsMonitorsItems
object
Information about the monitor.
7 properties
getMonitors
object
2 properties
CommonErrorTypeTitleDetailDetail
Information about the error.
MonitorDistributionItemsRegion
string
The assigned distribution region.
deleteMonitor
object
1 property
GetMonitorsRequestInternalServerError
MonitorRunStatsAssertions
object
Information about the monitor's tests.
2 properties
RunMonitorRequestUnauthorizedError
GetMonitorsRequestForbiddenError
MonitorDistributionItems
object
1 property
getRunnerMetrics
object
The runner instance's metrics information.
3 properties
GetMonitorRequestUnauthorizedError
GetRunnerMetricsRequestUnauthorizedError
active
boolean
MonitorRunErrorsItems
object
2 properties
environmentUid
string
CommonErrorNameMessageDetailsError
object
3 properties
async
boolean
CommonErrorNameMessageError
object
Information about the error.
2 properties
GetMonitorRequestForbiddenError
GetMonitorRequestInternalServerError
MonitorRunExecutionsItemsItem
object
Information about the executed item.
1 property
workspaceId
string
monitorRunInfo
object
Information about the monitor.
8 properties
DeleteMonitorRequestForbiddenError
UpdateMonitorRequestBadRequestError
commonErrorNameMessage
object
1 property
CreateUpdateMonitorResponseMonitor
object
Information about the monitor.
4 properties
DeleteMonitorMonitor
object
Information about the monitor.
2 properties
runnerInstance
object
Information about the runner instance.
7 properties
createUpdateMonitorResponse
object
1 property
runnerMeta
object
The response's meta information for paginated results.
4 properties
GetRunnerInstancesRequestUnauthorizedError
commonErrorTypeTitleDetailStatus
object
4 properties
getRunnerInstances
object
2 properties
DeleteMonitorRequestUnauthorizedError
MonitorNotificationsOnErrorItems
object
1 property
GetMonitorsMeta
object
The response's meta information for paginated results.
2 properties
UpdateMonitorMonitor
object
Information about the monitor.
8 properties
CreateMonitorRequestForbiddenError
monitorRunResponses
object
Information about the monitor run's response.
5 properties
limitDefault25
integer
monitorRunRequests
object
Information about the monitor run's requests.
5 properties
monitorRunStats
object
Information about the monitor run's stats.
7 properties
monitorId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

postman-monitors-api-openapi.yml Raw ↑

Other APIs Postman publishes across the network.

Postman Collections API
Postman Workspaces API
Postman Environments API
Postman Webhooks API
Postman Tags API
Postman MCP Server
Postman Flows
Postman Mocks API
Postman Analytics API
Postman API Catalog API
Postman Billing API
Where this information came from

This is an independent, third-party profile of Postman Monitors API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.