Update Monitor

PUT

/monitors/{monitor_uid}

Monitors

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 Postman 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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.getpostman.com/monitors/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "monitor": {
        "name": "Updated Monitor Name",
        "schedule": {
            "cron": "*/5 * * * *",
            "timezone": "America/Chicago"
        }
    }
}'

Response Example

{
  "monitor": {
    "id": "1e6b6e2a-c2ad-4090-b750-0df4e6624352",
    "name": "Updated Monitor Name",
    "uid": "5852-1e6b6e2a-c2ad-4090-b750-0df4e6624352"
  }
}

Request

Path Params

monitor_uid

string

required

Body Params application/json

monitor

object

optional

name

string

optional

Example:

Updated Monitor Name

schedule

object

optional

Examples

Responses

🟢200Monitor Updated

application/json

Body

monitor

object

optional

string

optional

Example:

1e6b6e2a-c2ad-4090-b750-0df4e6624352

name

string

optional

Example:

Updated Monitor Name

uid

string

optional

Example:

5852-1e6b6e2a-c2ad-4090-b750-0df4e6624352

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

Single Monitor

Run a Monitor