Create a monitor

POST

/monitors

POST

/monitors

$ curl -X POST "https://api.postman.com/monitors?workspace=1f0df51a-8658-4ee8-a2a1-d2567dfa09a9" \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "monitor": {
>     "name": "Test Monitor",
>     "collection": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
>     "schedule": {
>       "cron": "*/5 * * * *",
>       "timezone": "America/Chicago"
>     },
>     "active": true,
>     "notificationLimit": 2,
>     "environment": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e",
>     "retry": {
>       "attempts": 1
>     },
>     "options": {
>       "followRedirects": false,
>       "requestDelay": 5,
>       "requestTimeout": 4000,
>       "strictSSL": true
>     },
>     "distribution": [
>       {
>         "region": "us-east"
>       },
>       {
>         "region": "ca-central"
>       },
>       {
>         "region": "us-west"
>       }
>     ],
>     "notifications": {
>       "onError": [
>         {
>           "email": "taylor.lee@example.com"
>         }
>       ],
>       "onFailure": []
>     }
>   }
> }'

1 {
2   "monitor": {
3     "id": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
4     "name": "Test Monitor",
5     "active": true,
6     "uid": "12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1"
7   }
8 }

Creates a monitor.

Note:

You cannot create monitors for collections added to an API definition.
If you do not pass the workspace query parameter, the system creates the monitor in the oldest personal Internal workspace you own.

Creates a monitor. **Note:** - You cannot create monitors for collections added to an API definition. - If you do not pass the `workspace` query parameter, the system creates the monitor in the oldest personal Internal workspace you own.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

workspacestringRequired

The workspace's ID.

Request

This endpoint expects an object.

monitorobjectOptional

Information about the monitor.

Response

Successful Response

monitorobject

Information about the monitor.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error