Postman API
  1. Monitors
Postman API
  • API
    • Get all APIs
      GET
    • Create API
      POST
    • Delete an API
      DELETE
    • Single API
      GET
    • Update an API
      PUT
    • Get All API Versions
      GET
    • Create API Version
      POST
    • Delete an API Version
      DELETE
    • Get an API Version
      GET
    • Update an API Version
      PUT
    • Get contract test relations
      GET
    • Get documentation relations
      GET
    • Get environment relations
      GET
    • Get integration test relations
      GET
    • Get monitor relations
      GET
    • Get linked relations
      GET
    • Create relations
      POST
    • Create Schema
      POST
    • Get Schema
      GET
    • Update Schema
      PUT
    • Create collection from schema
      POST
    • Get test suite relations
      GET
    • Sync relations with schema
      PUT
  • Collections
    • All Collections
    • Create Collection
    • Create a Fork
    • Merge a Fork
    • Delete Collection
    • Single Collection
    • Update Collection
  • Environments
    • All Environments
    • Create Environment
    • Delete Environment
    • Single Environment
    • Update Environment
  • Import
    • Import exported data
    • Import external API specification
  • User
    • API Key Owner
  • Mocks
    • All Mocks
    • Create Mock
    • Delete Mock
    • Single Mock
    • Update Mock
    • Publish Mock
    • Unpublish Mock
  • Monitors
    • All Monitors
      GET
    • Create Monitor
      POST
    • Delete Monitor
      DELETE
    • Single Monitor
      GET
    • Update Monitor
      PUT
    • Run a Monitor
      POST
  • Webhooks
    • Create Webhook
  • Workspaces
    • All workspaces
    • Create Workspace
    • Delete Workspace
    • Single workspace
    • Update Workspace
  1. Monitors

Single Monitor

GET
/monitors/{monitor_uid}
Monitors
This endpoint fetches you basic information about the monitor using its uid.
Requires API Key as X-Api-Key request header or apikey URL query parameter.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.getpostman.com/monitors/'
Response Response Example
200 - Successful Response
{
  "monitor": {
    "collectionUid": "5852-8d05dd85-222c-1452-553b-e76a531b71ed",
    "distribution": [],
    "environmentUid": "5851-8d05dd85-222c-1452-553b-e76a531b71ed",
    "id": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
    "lastRun": {
      "finishedAt": "2020-03-25T15:45:31.340Z",
      "startedAt": "2020-03-25T15:45:29.218Z",
      "stats": {
        "assertions": {
          "failed": 1,
          "total": 8
        },
        "requests": {
          "total": 4
        }
      },
      "status": "failed"
    },
    "name": "Postman Echo Monitor",
    "notifications": {
      "onError": [
        {
          "email": "john.appleseed@example.com"
        }
      ],
      "onFailure": [
        {
          "email": "john.appleseed@example.com"
        }
      ]
    },
    "options": {
      "followRedirects": true,
      "requestDelay": 0,
      "requestTimeout": 3000,
      "strictSSL": true
    },
    "owner": "5852",
    "schedule": {
      "cron": "0 0 * * * *",
      "nextRun": "2016-11-30T09:30:00.000Z",
      "timezone": "Asia/Calcutta"
    },
    "uid": "5852-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1"
  }
}

Request

Path Params
monitor_uid
string 
required

Responses

🟢200Successful Response
application/json
Body
monitor
object 
optional
collectionUid
string 
optional
Example:
5852-8d05dd85-222c-1452-553b-e76a531b71ed
distribution
array
optional
environmentUid
string 
optional
Example:
5851-8d05dd85-222c-1452-553b-e76a531b71ed
id
string 
optional
Example:
1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
lastRun
object 
optional
name
string 
optional
Example:
Postman Echo Monitor
notifications
object 
optional
options
object 
optional
owner
string 
optional
Example:
5852
schedule
object 
optional
uid
string 
optional
Example:
5852-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
🟠404Monitor Not Found
Previous
Delete Monitor
Next
Update Monitor
Built with