Status Page

Create a new monitor

post/projects/{project_id}/monitors

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/monitors
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Request body

check_interval_secondsinteger nullable

How often to probe, in seconds. Defaults to 60 when omitted.

Clamped, not rejected: values below 30 are stored as 30 and non-positive values as 60, and the created monitor comes back with the clamped value — so the response always reports the interval the scheduler will actually use.

check_pathstring nullable
environment_idinteger required
monitor_typestring required
namestring required

Response

Monitor created successfully

check_interval_secondsinteger required
check_pathstring nullable
created_atstring date-time required
environment_idinteger nullable
idinteger required
is_activeboolean required
monitor_typestring required
monitor_urlstring required
namestring required
next_check_atstring date-time nullable

When the scheduler will next probe this monitor. Read-only: it is maintained by the health-check scheduler, never accepted on write. null means the monitor has not been scheduled yet and is due on the next sweep.

project_idinteger required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 53 revisions of this API.