Logo
30 days challenge API Documentation

Create Monitor

POST https://api.getpostman.com/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 Qodex 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.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status OK

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



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

ENDPOINTS