Docs & API

The console is a client of the same API you can use. Nothing in the product is reachable only by clicking.

Install the agent

Copy the command from the console with your key already filled in; the host appears in the fleet within a minute.

curl -fsSL https://portal.serverpal.net/install.sh \
  | SERVERPAL_AGENT_KEY=<your-key> bash
  • Single binary, outbound only, no inbound rule to open
  • Uninstalls cleanly when you decommission the host

Status page JSON

Public and read-only, with no key to manage. Available on Pro and above. See status pages for how the degraded state is decided.

GET https://serverpal.net/api/status/<slug>/v1

What the API covers

Authenticated against your account and scoped by the same project roles as the console, so an API caller can never reach further than the person who created it.

Monitors

Everything the monitor form does: type, interval, regions, expected status codes, keyword matching, response-time threshold and group.

Servers

Issue an agent key, set per-host alert thresholds, move a host between groups, or retire it.

Incidents

Open, update and resolve incidents, marking each update public or internal.

Status pages

Pages, their components and groups, branding, sections, the degraded threshold and the custom domain.

Alerting

Notification channels, and the policies grouping them with their delay, repeat and recovery rules.

Audit log

Pull the project audit log into your own compliance or reporting tooling.

The full endpoint reference lives in the console alongside your keys, so what you read always matches the version you are calling.

Start monitoring in about a minute.

Twenty checks and one server, free and with no card. Upgrade only when you outgrow it.