Create Monitor

POST

/monitors

Monitors

This endpoint allows you to create a monitor.

Some sample cron values are:

Frequency	Cron Pattern
Every 5 minutes	`/5 * * *`
Every 30 minutes	`/30 * * *`
Every Hour	`0 /1 * *`
Every 6 Hours	`0 /6 * *`
Every day at 5pm	`0 17 * * *`
Every Monday at 12pm	`0 12 * * MON`
Every weekday (Monday - Friday) at 6am	`0 6 * * MON-FRI`

Note: Currently, you can only create monitors at some limited schedules. You can head to Postman Monitors to see the allowed schedules.

For more information about the format of the timezone value, check this list of time zones.

You can also specify the context of a workspace to create a monitor in directly by passing the workspace as a query param.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.getpostman.com/monitors' \
--header 'Content-Type: application/json' \
--data-raw '{
    "monitor": {
        "collection": "5852-8d05dd85-222c-1452-553b-e76a531b71ed",
        "environment": "5852-8a4c21ea-2a36-40d1-a82d-d717fac9d6ef",
        "name": "This is a Monitor Name",
        "schedule": {
            "cron": "0 0 * * *",
            "timezone": "Asia/Kolkata"
        }
    }
}'

Response Example

200 - Create Monitor in a Workspace

{
  "monitor": {
    "id": "1e6b6dfd-7ba4-4590-9ee1-5948102d7797",
    "name": "Monitor Name",
    "uid": "5852-1e6b6dfd-7ba4-4590-9ee1-5948102d7797"
  }
}

Request

Body Params application/json

monitor

object

optional

collection

string

optional

Example:

5852-8d05dd85-222c-1452-553b-e76a531b71ed

environment

string

optional

Example:

5852-8a4c21ea-2a36-40d1-a82d-d717fac9d6ef

name

string

optional

Example:

This is a Monitor Name

schedule

object

optional

Examples

Responses

🟢200Create Monitor in a Workspace

application/json

Body

monitor

object

optional

string

optional

Example:

1e6b6dfd-7ba4-4590-9ee1-5948102d7797

name

string

optional

Example:

Monitor Name

uid

string

optional

Example:

5852-1e6b6dfd-7ba4-4590-9ee1-5948102d7797

🟠400Parameter Missing

Modified at 2023-08-15 05:41:03

All Monitors

Delete Monitor