Run a monitor

POST

/monitors/:monitorId/run

POST

/monitors/:monitorId/run

$ curl -X POST https://api.getpostman.com/monitors/1e6b6cc1-c760-48e0-968f-4bfaeeae9af1/run \
>      -H "x-api-key: <apiKey>"

1 {
2   "run": {
3     "info": {
4       "jobId": "1ecee76a-e14e-47c0-bddc-256bf690c407",
5       "collectionUid": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
6       "environmentUid": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e",
7       "monitorId": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
8       "name": "Test Monitor",
9       "status": "success",
10       "startedAt": "2025-06-17T19:50:04.019Z",
11       "finishedAt": "2025-06-17T19:50:06.439Z"
12     },
13     "stats": {
14       "assertions": {
15         "total": 5,
16         "failed": 0
17       },
18       "requests": {
19         "total": 3,
20         "failed": 0
21       },
22       "runCount": 3,
23       "errorCount": 2,
24       "abortedCount": 1,
25       "responseLatency": 850,
26       "responseSize": 2048
27     },
28     "executions": [
29       {
30         "id": 1,
31         "item": {
32           "name": "Sample POST Request"
33         },
34         "request": {
35           "method": "POST",
36           "url": "http://echo.getpostman.com/post",
37           "body": {
38             "contentLength": 0
39           },
40           "headers": {
41             "Accept": "*/*",
42             "Accept-Encoding": "gzip, deflate, br",
43             "Cache-Control": "no-cache",
44             "Connection": "keep-alive",
45             "Content-Length": "0",
46             "Content-Type": "application/json",
47             "Host": "echo.getpostman.com",
48             "Postman-Token": null,
49             "User-Agent": "PostmanRuntime/7.29.0"
50           },
51           "timestamp": "2025-06-17T19:50:06.186Z"
52         },
53         "response": {
54           "body": {
55             "contentLength": 50
56           },
57           "code": 200,
58           "headers": {
59             "Connection": "keep-alive",
60             "Content-Length": "50",
61             "Content-Type": "text/plain",
62             "Date": "Fri, 17 Jun 2025 19:50:06 GMT",
63             "Server": null
64           },
65           "responseSize": 50,
66           "responseTime": 49
67         }
68       }
69     ],
70     "failures": []
71   }
72 }

Runs a monitor and returns its run results.

Note:

If you pass the async=true query parameter, the response does not return the stats, executions, and failures responses. To get this information for an asynchronous run, call the GET /monitors/{id} endpoint.
If the call exceeds 300 seconds, the endpoint returns an HTTP 202 Accepted response. Use the GET /monitors/{id} endpoint to check the run’s status in the response’s lastRun property. To avoid this, it is recommended that you include the async=true query parameter when using this endpoint.

Runs a monitor and returns its run results. **Note:** - If you pass the `async=true` query parameter, the response does not return the `stats`, `executions`, and `failures` responses. To get this information for an asynchronous run, call the GET `/monitors/{id}` endpoint. - If the call exceeds 300 seconds, the endpoint returns an HTTP `202 Accepted` response. Use the GET `/monitors/{id}` endpoint to check the run's status in the response's `lastRun` property. To avoid this, it is recommended that you include the `async=true` query parameter when using this endpoint.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

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

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

monitorIdstringRequired

The monitor's ID.

Query parameters

asyncbooleanOptionalDefaults to false

If true, runs the monitor asynchronously from the created monitor run task. By default, the server will not respond until the task finishes (false).

Response

Successful Response

runobject

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 get this information for an asynchronous run, call the GET /monitors/{id} endpoint.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error