Skip to content

Overview

The Perstat API gives you programmatic access to your monitoring data: monitors, incidents, status pages, maintenance windows, webhooks, and organization management.

Authentication

Authenticate with an API key as a Bearer token: create keys in your organization settings (API keys section) in the Perstat app, then send Authorization: Bearer pst_… with every request. Keys are organization-bound, carry explicit scopes (resource:read or resource:write, where write implies read), and can be narrowed to specific projects or monitors. During the beta, API keys are accepted on a growing subset of endpoints, marked with x-api-key-enabled; the remaining documented endpoints currently require a browser session and gain key support incrementally.

Stability

This specification is versioned independently of the product. Additive changes (new fields, new endpoints) can happen at any time; removals or renames only after a deprecation window of at least 90 days, announced in the changelog on perstat.io. Operation ids are stable identifiers.

Webhooks

Outbound webhook deliveries are signed with an HMAC-SHA256 signature in the x-perstat-signature header (sha256= over the raw body) so you can verify authenticity with your signing secret.

Information

  • OpenAPI version: 3.1.0

Security scheme type: http

Bearer format: pstsvc_ opaque service token

Security scheme type: http

Bearer format: opaque session token