Create Monitor

v1.0.0

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 to see the allowed schedules.

For more information about the format of the timezone value, check this

You can also specify the context of a workspace to create a monitor in directly by passing the workspace as a query param.

Requires as X-Api-Key request header or apikey URL query parameter.

Input

{
  "type": "object",
  "properties": {
    "monitor": {
      "type": "object",
      "properties": {
        "collection": {
          "type": "string"
        },
        "environment": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "schedule": {
          "type": "object",
          "properties": {
            "cron": {
              "type": "string"
            },
            "timezone": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Output

{
  "type": "object",
  "properties": {
    "monitor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "uid": {
          "type": "string"
        }
      }
    }
  }
}