MonSPHERE

Getting Started

Getting Started

Register an organization, invite your team, and monitor your first system.

MonSPHERE is organized around organizations — every account belongs to at least one, and everything you create (monitors, dashboards, alert rules, API keys) is scoped to one organization.

1. Create an account

curl -X POST https://api.monsphere.com/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@company.com",
    "password": "a-strong-password",
    "organizationName": "Acme Inc"
  }'

Registration creates your user, a new organization with you as Owner, and a Free plan subscription automatically (5 monitors, 1 agent, 3 users, 7-day retention).

2. Sign in

curl -X POST https://api.monsphere.com/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "you@company.com", "password": "a-strong-password"}'

This returns a short-lived access token and a refresh token. If MFA is enabled on the account, you'll get a challenge token instead — see Authentication.

3. Invite your team

Owners and Admins can invite members with POST /api/v1/organizations/:orgId/members/invite. New members land with the Member role by default; assign Operator, Developer, Admin, or a custom role as needed — see RBAC & Custom Roles.

4. Install an agent

The fastest way to start monitoring real infrastructure is the MonSPHERE agent — it connects over mTLS gRPC and installs/supervises Prometheus exporters on the host automatically. See Agent & Exporter Installation.

5. Create your first monitor

curl -X POST https://api.monsphere.com/api/v1/monitors \
  -H "X-Api-Key: msk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Production API", "type": "https", "target": "https://api.example.com/health", "intervalSeconds": 60}'

Monitor type can be http, https, ping, tcp, dns, ssl, or heartbeat. Once created, quota is enforced against your plan's monitor_limit — creating past the limit returns a 403 quota_exceeded.

From here: build a dashboard, wire up an alert rule, and connect a notification channel.