Better Stack · Schema

MonitorCreateRequest

Request body for creating a new monitor.

IncidentsLogsMonitoringPlatformStatusUptimeObservabilityOn-CallHeartbeats

Properties

Name Type Description
url string The URL to monitor.
pronounceable_name string Human-readable name for the monitor.
monitor_type string Type of monitoring check.
check_frequency integer Check interval in seconds.
verify_ssl boolean Whether to verify SSL certificate.
email boolean Alert via email.
sms boolean Alert via SMS.
call boolean Alert via phone call.
push boolean Alert via push notification.
regions array Regions to monitor from.
policy_id string Escalation policy ID.
View JSON Schema on GitHub

JSON Schema

better-stack-monitor-create-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/better-stack/refs/heads/main/json-schema/better-stack-monitor-create-request-schema.json",
  "title": "MonitorCreateRequest",
  "description": "Request body for creating a new monitor.",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL to monitor.",
      "example": "https://example.com"
    },
    "pronounceable_name": {
      "type": "string",
      "description": "Human-readable name for the monitor.",
      "example": "Production API"
    },
    "monitor_type": {
      "type": "string",
      "description": "Type of monitoring check.",
      "enum": [
        "status",
        "expected_status_code",
        "keyword",
        "keyword_absence",
        "ping",
        "tcp"
      ],
      "example": "status"
    },
    "check_frequency": {
      "type": "integer",
      "description": "Check interval in seconds.",
      "example": 180
    },
    "verify_ssl": {
      "type": "boolean",
      "description": "Whether to verify SSL certificate.",
      "example": true
    },
    "email": {
      "type": "boolean",
      "description": "Alert via email.",
      "example": true
    },
    "sms": {
      "type": "boolean",
      "description": "Alert via SMS.",
      "example": false
    },
    "call": {
      "type": "boolean",
      "description": "Alert via phone call.",
      "example": false
    },
    "push": {
      "type": "boolean",
      "description": "Alert via push notification.",
      "example": true
    },
    "regions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Regions to monitor from.",
      "example": [
        "us",
        "eu"
      ]
    },
    "policy_id": {
      "type": "string",
      "nullable": true,
      "description": "Escalation policy ID.",
      "example": "300010"
    }
  },
  "required": [
    "url"
  ]
}