Quickstart: create your first synthetic check in 5 minutes
Owner Sarah Ofori · Last updated 2026-04-08 · v4.2
quickstartmonitorhttpfirst-checkonboarding
Quickstart
This walks you through creating your first DevFlow synthetic check. It assumes you already have an account — sign up at devflow.io if not.
install the CLI
The CLI is the fastest way to get a monitor running. It also drives our terraform-provider under the hood.
bash
npm install -g @devflow/cli
devflow login
# Opens a browser for OAuth. Token stored in ~/.devflow/credentials.create the monitor
Save the following to api-status.yaml:
yaml
name: api-status
url: https://api.example.com/health
method: GET
frequency: 30s
regions: [us-east-1, eu-west-1, ap-southeast-1]
assertions:
- status_eq: 200
- latency_lt_ms: 800
- body_jsonpath:
path: $.status
eq: ok
alert_channels:
- slack:#oncallThen push it:
bash
devflow monitor apply -f api-status.yamlThe CLI prints the monitor URL on success. The first check fires within ten seconds.
what to do next
- Add more assertions — see response-assertions for the full assertion vocabulary.
- Wire your alert channels — slack-integration and pagerduty-integration.
- Start tracking an SLO instead of a checkbox uptime number — slo-overview.
- Move from one monitor to many: tagging strategy and project structure are covered in tagging-strategy and account-setup.
If something doesn't work, the troubleshooting-flapping-monitors doc covers most first-check issues — most often timeout or assertion strictness.