{
  "opencollection": "1.0.0",
  "info": {
    "name": "Postman Monitors API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "monitors",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all monitors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.postman.com/monitors",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace",
                "value": "",
                "type": "query",
                "description": "Return only results found in the given workspace ID."
              },
              {
                "name": "active",
                "value": "",
                "type": "query",
                "description": "If true, return only active monitors."
              },
              {
                "name": "owner",
                "value": "",
                "type": "query",
                "description": "Return only results that belong to the given user ID."
              },
              {
                "name": "collectionUid",
                "value": "",
                "type": "query",
                "description": "Filter the results by a collection's unique ID."
              },
              {
                "name": "environmentUid",
                "value": "",
                "type": "query",
                "description": "Filter the results by an environment's unique ID."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of rows to return in the response, up to a maximum value of 25. Any value greater than 25 returns a 400 Bad Request response."
              }
            ]
          },
          "docs": "Gets all monitors."
        },
        {
          "info": {
            "name": "Create a monitor",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.postman.com/monitors",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace",
                "value": "",
                "type": "query",
                "description": "The workspace's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a monitor.\n\n**Note:**\n\n- You cannot create monitors for collections added to an API definition.\n- If you do not pass the `workspace` query parameter, the system creates the monitor in the oldest personal Internal workspace you own.\n"
        },
        {
          "info": {
            "name": "Get a monitor",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.postman.com/monitors/:monitorId",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "monitorId",
                "value": "",
                "type": "path",
                "description": "The monitor's ID."
              }
            ]
          },
          "docs": "Gets information about a monitor."
        },
        {
          "info": {
            "name": "Update a monitor",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.postman.com/monitors/:monitorId",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "monitorId",
                "value": "",
                "type": "path",
                "description": "The monitor's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a monitor's [configurations](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/#configure-a-monitor)."
        },
        {
          "info": {
            "name": "Delete a monitor",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.postman.com/monitors/:monitorId",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "monitorId",
                "value": "",
                "type": "path",
                "description": "The monitor's ID."
              }
            ]
          },
          "docs": "Deletes a monitor."
        },
        {
          "info": {
            "name": "Run a monitor",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.postman.com/monitors/:monitorId/run",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "monitorId",
                "value": "",
                "type": "path",
                "description": "The monitor's ID."
              },
              {
                "name": "async",
                "value": "",
                "type": "query",
                "description": "If true, runs the monitor asynchronously from the created monitor run task. By default, the server will not respond until the task finishes (`false`)."
              }
            ]
          },
          "docs": "Runs a monitor and returns its run results.\n\n**Note:**\n\n- 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.\n- 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 t"
        },
        {
          "info": {
            "name": "Get all runner instances",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.postman.com/runners/:runnerId/instances",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "runnerId",
                "value": "",
                "type": "path",
                "description": "The runner's ID."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of rows to return in the response, up to a maximum value of 25. Any value greater than 25 returns a 400 Bad Request response."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter."
              }
            ]
          },
          "docs": "Gets all instances of the runner polling Postman for upcoming monitor runs. Instances are runner executions that share the same runner ID and key.\n\n**Note:**\n\nYou can get a runner's ID in the Postman UI if you have an Admin or Super Admin role. To do this, click **Team > Team Settings** in Postman, then click **Runners**. Click the runner you want to get the ID of, then copy its ID from the URL.\n"
        },
        {
          "info": {
            "name": "Get runner metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.postman.com/runners/:runnerId/metrics",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "runnerId",
                "value": "",
                "type": "path",
                "description": "The runner's ID."
              }
            ]
          },
          "docs": "Gets the Postman server-side metrics for a runner instance. Metrics include information such as monitor run queues and last polling date.\n\n**Note:**\n\nYou can get a runner's ID in the Postman UI if you have a Team Admin or Super Admin role. To do this, click **Team > Team Settings** in Postman, then click **Runners**. Click the runner you want to get the ID of, then copy its ID from the URL.\n"
        }
      ]
    }
  ],
  "bundled": true
}