Skip to content

Start uptime monitoring

Set up a trial workspace that continuously checks whether a URL is reachable and alerts you when it goes down.

POST/v1/quickstart/startMonitoring

Request

FieldTypeDescription
emailstringEmail address for the trial workspace. An activation link will be sent here.
expected_statusintegerExpected HTTP status code. Defaults to 200.
intervalstringHow often to check the endpoint. One of: 1m, 5m, 15m, 1h.
urlstringFull URL of the endpoint to monitor.

Example

{
  "email": "dev@acme.com",
  "expected_status": 200,
  "interval": "5m",
  "url": "https://api.acme.com/health"
}

Or using curl:

bash
curl -X POST https://api.navi.sh/v1/quickstart/startMonitoring \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "turnstile_token": "0.abc123...",
    "url": "https://example.com",
    "interval": "5m",
    "expected_status": 200
  }'

Response

StatusDescription
200Trial workspace created. Activation email sent.
403Captcha verification failed. Please try again.
409An organization with this email domain already exists.
422Validation error: invalid interval (allowed: 1m, 5m, 15m, 1h) or disposable email domain.
429Too many requests for this email. Please wait 30 minutes.
500Unexpected server error.

On success:

{
  "message": "Monitoring started. Check your email to access your dashboard.",
  "status": "ok"
}

Built by the Navi.sh team.