Create a monitor

POST {{baseUrl}}/monitors

Creates a monitor. Include the following properties in the request body:

• name — A string value that contains the monitor's name.

• schedule — An object that contains the following properties:

  • cron — A string value that contains the monitor's run frequency, based on the given cron pattern. Refer to the Cron examples table for examples of valid 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.

Cron examples

Note:

You cannot create monitors for collections added to an API definition.

Request Params

Request Body

{"monitor"=>{"name"=>"{{monitorName}}", "schedule"=>{"cron"=>"{{cronFrequencyPattern}}", "timezone"=>"{{monitorTimezone}}"}, "collection"=>"{{collectionUid}}", "environment"=>"{{environmentUid}}"}}

RESPONSES

status: OK

{"monitor":{"id":"1e6b6cc1-c760-48e0-968f-4bfaeeae9af1","name":"Test Monitor","uid":"12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1"}}