Create Monitor Tool
create-monitorCreate an uptime monitor for the team. Call get-plan-usage first to confirm there is room and to find the shortest allowed interval. A heartbeat monitor returns the heartbeat_url your job must request after each run.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "<name>",
"type": "<type>",
"check_interval_minutes": "<check_interval_minutes>"
},
"name": "create-monitor"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | A full URL such as https://shop.example.com. tcp and icmp use only its host. Required unless type is heartbeat. | |
| name | Yes | Human-readable monitor name. | |
| port | No | Required when type is tcp: port 1-65535. | |
| type | Yes | Monitor type. http, ssl, keyword, tcp and icmp need a url; tcp also needs a port; heartbeat waits for your job to ping it. The type cannot change later. | |
| password | No | HTTP basic-auth password. Stored encrypted and never returned. | |
| username | No | HTTP basic-auth user name. | |
| is_active | No | false creates the monitor paused (default true). | |
| http_method | No | HTTP method (default GET). | |
| request_headers | No | Extra request headers, name to value, e.g. {"X-Env": "live"}. | |
| expected_keyword | No | Required when type is keyword: text expected in the response body. | |
| expected_status_codes | No | HTTP status codes counted as up (default [200]). | |
| check_interval_minutes | Yes | Check frequency in minutes. Must be allowed by the plan (free = 5 or more). | |
| check_interval_seconds | No | Optional exact interval in seconds, at least the plan minimum; overrides the minutes. For a daily heartbeat use about 90000. | |
| request_timeout_seconds | No | Request timeout 1-60 seconds (default 30). | |
| ssl_expiry_warning_days | No | Warn this many days before SSL expiry (default 14). | |
| notification_contact_ids | No | IDs from list-notification-contacts to alert when this monitor changes state. |