Skip to main content
POST
/
monitors
Create a new monitor
curl --request POST \
  --url https://api.example.com/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "interval": 43230,
  "isActive": true,
  "projectId": "<string>",
  "settings": {
    "timeout": 2,
    "retries": 1,
    "alertThreshold": 2,
    "expectedStatusCode": 123,
    "expectedResponse": "<string>",
    "method": "GET",
    "headers": {},
    "body": "<string>"
  },
  "notifications": {
    "enabled": true,
    "email": true,
    "slack": false,
    "discord": false,
    "teams": false,
    "webhook": false,
    "threshold": 2,
    "recipients": [
      "<string>"
    ]
  },
  "regions": [
    "<string>"
  ]
}
'
{}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

The name of the monitor

url
string
required

The URL to monitor

interval
number
required

The interval between checks in seconds

Required range: 60 <= x <= 86400
isActive
boolean
default:true
required

Whether the monitor is active

projectId
string
required

The project ID this monitor belongs to

settings
object
required
notifications
object
required
regions
string[]
required

Selected monitoring regions

Response

201 - application/json

The monitor has been successfully created.

The response is of type object.