Create a monitor
POST {{baseUrl}}/monitors
Creates a monitor. Include the following properties in the request body: Cron patterns Note: You cannot create monitors for collections added to an API definition.
name — A string value that contains the monitor's name.schedule — An object that contains the following properties:
cron — A string value the monitor's run frequency. At this time you can only create monitors with limited schedules. For information about the available schedules, see our Qodex Monitors collection. See the table below for cron patterns.timezone — A string value that contains the monitor's timezone.collection — A string value that contains the monitor's associated collection unique ID.environment — A string value that contains the monitor's associated environment unique ID.
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
Body
PARAM
| Key | Datatype | Required | Description |
workspace
|
string | The workspace ID. |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string |
RESPONSES
status OK
| {
"monitor": {
"id": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
"name": "Test Monitor",
"uid": "12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1"
}
} |
ENDPOINTS