POST /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-Keyrequest header orapikeyURL query parameter.
Servers
- https://api.getpostman.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
monitor |
Object | No | |
monitor.name |
String | No | |
monitor.collection |
String | No | |
monitor.environment |
String | No | |
monitor.schedule |
Object | No | |
monitor.schedule.timezone |
String | No | |
monitor.schedule.cron |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.