30 Days of Postman API Documentation

Update Monitor

PUT https://api.getpostman.com/monitors/{{monitor_uid}}

This endpoint allows you to update a monitor using its uid. Only the monitor name and its schedule can be updated.

Some example 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.

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":"1e6b6e2a-c2ad-4090-b750-0df4e6624352","name":"Updated Monitor Name","uid":"5852-1e6b6e2a-c2ad-4090-b750-0df4e6624352"}}

Curl

curl -X PUT 'https://api.getpostman.com/monitors/undefined' -H 'Content-Type: application/json' -d '{"monitor":{"name":"Updated Monitor Name","schedule":{"cron":"*/5 * * * *","timezone":"America/Chicago"}}}'