PulsAPI Developer Hub

REST API

Base URL https://www.pulsapi.com/api. Responses are JSON; timestamps are ISO 8601 in UTC; collections come back in a page envelope with content and totalElements.

curl -s https://www.pulsapi.com/api/services/github | jq '{name, currentStatus, uptimePercent}'

curl -s "https://www.pulsapi.com/api/services?status=MAJOR_OUTAGE&limit=50" | jq '.content[].name'

curl -s -H "X-API-Key: $PULSAPI_KEY" \
  "https://www.pulsapi.com/api/user/services/stripe/sla?days=90"

The endpoints you will reach for first

The complete list, with typed parameters and response schemas, is in /openapi.json (YAML).

Authentication and scopes

Status reads are open. Anything account-specific — SLA reports, monitors, alert rules — needs an API key, created in Settings → API Keys. Send it as X-API-Key or as a bearer token.

curl -H "X-API-Key: pb_..." https://www.pulsapi.com/api/user/api-keys
curl -H "Authorization: Bearer pb_..." https://www.pulsapi.com/api/user/api-keys

Scopes

Every key carries an explicit scope list, chosen when the key is created. An operation refuses a key that lacks its scope with 403 and names the scope it wanted, so an agent can ask for exactly what it needs and nothing more. Each operation in the OpenAPI document declares its requirement under x-required-scopes.

Keys created before scopes existed hold every scope, so nothing that worked before stopped working. Narrow them when you rotate.

MCP server

PulsAPI speaks the Model Context Protocol at https://www.pulsapi.com/api/mcp over Streamable HTTP, protocol revision 2025-06-18. Anonymous clients get the public status tools under a per-IP budget; a key with mcp:invoke lifts that and unlocks the rest.

{
  "mcpServers": {
    "pulsapi": {
      "type": "http",
      "url": "https://www.pulsapi.com/api/mcp"
    }
  }
}

curl -s https://www.pulsapi.com/api/mcp \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

Tools

• list_servicesList services monitored by PulsAPI with their current status, filterable by category and status.
• get_service_statusGet the current status and details for one service by its slug.
• list_incidentsList active or recent incidents across all monitored services.
• get_component_statusGet the current status of the components inside a service, such as a region or subsystem.
• get_uptime_reportkey requiredGet uptime statistics and SLA compliance for a service over a time range. Requires a plan with MCP access.

Command-line interface

@pulsapi/cli wraps the same public API. It needs no key for status commands, prints a table by default and JSON with --json, and exits non-zero when a vendor you asked about is not operational — which is what makes it usable as a CI gate.

npm install -g @pulsapi/cli

# or, without installing:
npx @pulsapi/cli status github

pulsapi status github                 # one vendor, human-readable
pulsapi status aws stripe --json      # several, machine-readable
pulsapi incidents --active            # what is broken right now
pulsapi uptime cloudflare --days 90   # uptime and MTTR
pulsapi check openai --fail-on degraded   # exit 1 if degraded or worse

Machine-readable index

Every discovery file PulsAPI publishes. The homepage also advertises them as RFC 8288 Link headers, so an agent can find them from a HEAD / alone.

• /sitemap.xmlEvery indexable URL on the site, with real last-modified dates.
• /llms.txtPlain-text site summary: what PulsAPI is, pricing, and the link map.
• /openapi.jsonThe full public API surface, typed, with an operationId on every operation.
• /.well-known/mcp.jsonModel Context Protocol server manifest, Streamable HTTP transport.
• /.well-known/api-catalogRFC 9727 linkset pointing at the spec, docs, and health endpoint.