{"data":{"name":"Sites in the Woods API","auth":"Authorization: Bearer sm_…, a key from the dashboard's API keys page (team sign-in cookies work too, for reads). Viewer keys read; Member and Admin keys, on teams with 10 sites or more, also write.","docs":"/api/docs","openapi":"/api/openapi.json","routes":[{"method":"GET","path":"/api/status","summary":"Every one of the team's sites: its status right now, and the open incidents","description":"Call this first, or on a schedule (at most once a minute, as often as the checks run), to see whether anything is down or warning right now."},{"method":"GET","path":"/api/sites","summary":"The team's sites: status, homepage uptime over 1, 7 and 30 days, open incidents","description":"Call this to compare sites or report on uptime over the last day, week or month. It also lists the slugs every other route takes."},{"method":"GET","path":"/api/sites/:slug","summary":"One site: its last 7 days (as in the weekly brief), open incidents, domain and TLS expiry","description":"Call this to answer questions about one site: how it did this week, what's wrong with it now, and when its domain or certificate runs out."},{"method":"GET","path":"/api/sites/:slug/insights","summary":"One site's daily insights: page weight, security headers, prefetches, page errors, broken links, cache, dead ends","description":"Call this when a site is slow or heavy, or to find what to fix: the daily browser load's page weight, missing security headers, JavaScript errors and broken links."},{"method":"GET","path":"/api/sites/:slug/scans","summary":"One site's API recovery scans, newest first: state, how each ended, and findings by weight","description":"Call this to see whether a site has been scanned for dead ends (API errors that don't say how to recover, lists without paging, pages nothing links to) and how the last scan came out. Scans are started from the dashboard by an admin or owner."},{"method":"GET","path":"/api/sites/:slug/scans/:id","summary":"One API recovery scan: what it saw, its findings, the fixes and what changed since the last scan","description":"Call this for a scan's results: findings by weight with the places on the site, three to five fixes in words and as a block for a coding agent, and new, fixed and still-open findings since the previous scan. It never includes text from the scanned site."},{"method":"GET","path":"/api/sites/:slug/maintenance","summary":"One site's maintenance windows: on now, scheduled, and the last 30 days","description":"Call this to see whether a site is in a maintenance window (its alerts held, its uptime not counting that time) and when the next one is. Windows are started from the dashboard or a deploy calling the site's maintenance URL (POST <url>/start?minutes=30, POST <url>/end), which the dashboard shows to admins."},{"method":"GET","path":"/api/sites/:slug/map","summary":"One site's structure from its sitemaps: sections, new and removed pages, what fails","description":"Call this to see where a site is changing or breaking without crawling it: every path with pages under it, with new and removed pages in the window, pages that fail, broken links and sitemaps that miss pages. Add ?section= for one section's pages. Our sites only (competitors' sitemaps aren't read)."},{"method":"GET","path":"/api/sites/:slug/events","summary":"What changed on one site: incidents opened and resolved, code pushes, maintenance, new pages","description":"Call this to find what changed before a number moved (clicks fell, pages got slower): the site's timeline, newest first, the same events the dashboard draws on its charts. Page through with limit and offset."},{"method":"GET","path":"/api/incidents","summary":"Incidents, open now or recent; open outages and slowdowns carry the likely cause","description":"Call this to see what went wrong and why: open and recent incidents, newest first, with the likely cause on open outages and slowdowns. Page through with limit and offset."},{"method":"GET","path":"/api/domains","summary":"The team's domains: registration expiry, registrar, nameservers, status","description":"Call this to check renewals: which domains expire soon, who the registrar is, and whether nameservers or registry locks changed."},{"method":"POST","path":"/api/incidents/:id/dismiss","summary":"Dismiss an open incident as noise","description":"Hides it from the open lists for the whole team; it never alerts again and closes without a message. Not every kind can be dismissed (409)."},{"method":"POST","path":"/api/incidents/:id/undismiss","summary":"Bring back a dismissed incident","description":"Undoes a dismiss: the incident shows and alerts again."},{"method":"POST","path":"/api/incidents/:id/recheck","summary":"Check an incident again now","description":"The monitor checks it again within 30 seconds, after a fix, instead of waiting for the next scheduled check. Not every kind can be checked again (409)."},{"method":"POST","path":"/api/sites/:slug/maintenance/start","summary":"Start a maintenance window on a site now","description":"Call this before a deploy: alerts for the site are held (checks still run) until the window ends, after `minutes` (default 30, at most 24 hours) or when you end it. Starting again replaces the open window."},{"method":"POST","path":"/api/sites/:slug/maintenance/end","summary":"End a site's maintenance windows now","description":"Call this after a deploy: alerts for the site go out again from now. Ending with no window on answers `ended: 0`."},{"method":"POST","path":"/api/sites/:slug/pause","summary":"Pause a site's checks","description":"Stops every check of the site, keeping its history, until it's resumed. Nothing alerts while it's paused."},{"method":"POST","path":"/api/sites/:slug/resume","summary":"Resume a paused site's checks","description":"Starts the site's checks again within a minute."}]}}