Better Stack · JSON Structure

Better Stack Monitor Create Request Structure

Request body for creating a new monitor.

Type: object Properties: 11 Required: 1
IncidentsLogsMonitoringPlatformStatusUptimeObservabilityOn-CallHeartbeats

MonitorCreateRequest is a JSON Structure definition published by Better Stack, describing 11 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

url pronounceable_name monitor_type check_frequency verify_ssl email sms call push regions policy_id

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/better-stack/refs/heads/main/json-structure/better-stack-monitor-create-request-structure.json",
  "name": "MonitorCreateRequest",
  "description": "Request body for creating a new monitor.",
  "type": "object",
  "properties": {
    "url": {
      "type": "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": "int32",
      "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"
  ]
}