spooky particles

REST API

The API lives under https://spookyparticles.com/api/v1. It is the same API the web app uses.

Keys

Send a key as a bearer token. Keys start with sp_. A person makes keys under /app/agents.

bash
printf 'Authorization: Bearer %s\n' "$SPOOKY_API_KEY" | curl -s -H @- https://spookyparticles.com/api/v1/incidents

This form keeps the key out of your shell history and process list.

  • Read keys can look at account data.
  • Write keys can also create, change and remove Spooky records.
  • Full control keys add key management, agent sign-in approval and account deletion.

Endpoints

PathWhat it is
/incidentsWhat is broken now, with the log line that says why.
/checkinsScheduled jobs and whether they checked in. See Check-ins.
/alarmsAlarm checks. See Alarm checks.
/mutesWhat is muted. POST to mute, DELETE to watch again. Needs write.
/projectsYour projects.
/projects/{owner}/{repo}One project.
/activityRecent activity.
/spendSpend by project.
/findingsCheck findings.
/expirationsKnown Vercel dates and domains with unknown dates.
/inventoryWhat Spooky found.
/graphThe map.
/connectionsConnected accounts.

GET reads. Changing anything needs a write key.

Errors

Errors share one shape.

json
{ "error": { "code": "insufficient_scope", "message": "This key lacks the \"write\" scope" } }
StatusCodeMeaning
401invalid_api_keyThe key is unknown, revoked or expired, or the header is not Bearer sp_....
403insufficient_scopeThe key lacks the scope this call needs.
404not_foundNo such record.
400variesThe body failed a check. The message says which field.