SysmosSysmos Docs
API Monitor

Setup

Set up API monitoring in Sysmos to track endpoint health across regions.

API monitoring in Sysmos runs distributed workers that check your endpoints from multiple global regions. Setup takes less than a minute.

Create Your First Monitor

  1. Log in to the Sysmos dashboard
  2. Navigate to API Monitors in the sidebar
  3. Click Create Monitor
  4. Fill in the monitor details:
FieldDescriptionExample
NameA friendly name for this monitorProduction API Health
URLThe endpoint to checkhttps://api.example.com/health
MethodHTTP methodGET
IntervalCheck frequency60s
RegionsWhere to run checks fromUS East, EU West
TimeoutMax wait time per check10s
  1. Click Save

Your monitor starts running immediately.

Advanced Options

Custom Headers

Add headers for authentication or custom routing:

{
  "Authorization": "Bearer your-token",
  "X-Custom-Header": "value"
}

Request Body

For POST, PUT, and PATCH monitors, you can specify a JSON request body:

{
  "test": true,
  "timestamp": "{{now}}"
}

Assertions

Define conditions that must be met for the check to be considered successful:

  • Status codeequals 200, in range 200-299
  • Response bodycontains "ok", does not contain "error"
  • Response timeless than 2000ms
  • HeadersContent-Type contains application/json

If any assertion fails, the check is marked as failed and alert rules are evaluated.

Monitor States

StateMeaning
UpAll assertions pass from all selected regions
DegradedAssertions fail from some regions but not all
DownAssertions fail from all selected regions
PausedMonitor is manually paused

On this page