Reference
API endpoints
This page is generated from the public OpenAPI document emitted by the API app.
Machine-readable source
The same source also publishes /openapi.json.
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /health | Get service health | Public |
| GET | /live | Get liveness status | Public |
| GET | /ready | Get readiness status | Public |
| DELETE | /v1/account | Delete the current organization account | Browser session |
| GET | /v1/account/export | Export retained organization account data | Browser session |
| GET | /v1/alerts | List alert rules | Browser session, Member bearer token |
| POST | /v1/alerts | Create an alert rule | Browser session, Member bearer token |
| PATCH | /v1/alerts/{id} | Update an alert rule | Browser session, Member bearer token |
| DELETE | /v1/alerts/{id} | Delete an alert rule | Browser session, Member bearer token |
| POST | /v1/auth/accept-invite | Accept an organization invite | Browser session |
| GET | /v1/auth/github/callback | Complete GitHub OAuth | Public |
| GET | /v1/auth/github/start | Start GitHub OAuth | Public |
| POST | /v1/auth/logout | Revoke the current browser session | Browser session |
| POST | /v1/auth/request-code | Request a one-time email code | Public |
| GET | /v1/auth/session | Resolve the current browser session | Browser session |
| POST | /v1/auth/verify-code | Verify a one-time email code and create a browser session | Public |
| GET | /v1/billing | Get the billing summary | Browser session, Member bearer token |
| POST | /v1/billing/capacity/increase | Increase capacity immediately | Browser session, Member bearer token |
| POST | /v1/billing/capacity/scheduled-reduction | Schedule a capacity reduction | Browser session, Member bearer token |
| DELETE | /v1/billing/capacity/scheduled-reduction | Cancel a scheduled capacity reduction | Browser session, Member bearer token |
| POST | /v1/billing/checkout | Create a Stripe checkout link | Browser session |
| POST | /v1/billing/portal | Create a Stripe customer portal link | Browser session |
| POST | /v1/events | Ingest batched events | Project bearer token |
| GET | /v1/incidents | List incidents | Member bearer token |
| GET | /v1/incidents/{id} | Get a single incident | Member bearer token |
| GET | /v1/incidents/{id}/bundle | Get the generated bundle for an incident | Member bearer token |
| POST | /v1/incidents/{id}/reopen | Reopen an incident | Member bearer token |
| GET | /v1/incidents/{id}/reproduction | Get the reproduction artifact for an incident | Member bearer token |
| POST | /v1/incidents/{id}/resolve | Resolve an incident | Member bearer token |
| GET | /v1/logs | Query incident logs | Member bearer token |
| GET | /v1/member/tokens | List member tokens | Member bearer token |
| POST | /v1/member/tokens | Create a member token | Browser session, Member bearer token |
| POST | /v1/member/tokens/{tokenId}/revoke | Revoke a member token | Member bearer token |
| GET | /v1/organization/members | List organization members | Browser session, Member bearer token |
| PATCH | /v1/organization/members/{userId} | Update an organization member role | Browser session, Member bearer token |
| DELETE | /v1/organization/members/{userId} | Remove an organization member | Browser session, Member bearer token |
| POST | /v1/organization/members/invite | Invite an organization member | Browser session, Member bearer token |
| GET | /v1/organization/members/invites | List pending organization invites | Browser session, Member bearer token |
| DELETE | /v1/organization/members/invites/{inviteId} | Cancel an organization invite | Browser session, Member bearer token |
| GET | /v1/projects | List projects | Browser session, Member bearer token |
| POST | /v1/projects | Create a project | Browser session, Member bearer token |
| PATCH | /v1/projects/{id} | Update a project | Browser session, Member bearer token |
| DELETE | /v1/projects/{id} | Delete a project | Browser session, Member bearer token |
| GET | /v1/projects/{id}/capture-policy | Get the resolved capture policy for a project | Browser session, Member bearer token |
| PATCH | /v1/projects/{id}/capture-policy | Update the capture policy for a project | Browser session, Member bearer token |
| GET | /v1/projects/{id}/probes | List active remote probes | Member bearer token |
| POST | /v1/projects/{id}/probes/activate | Activate remote probes | Member bearer token |
| POST | /v1/projects/{id}/probes/deactivate | Deactivate a remote probe | Member bearer token |
| GET | /v1/projects/{id}/tokens | List project tokens | Member bearer token |
| POST | /v1/projects/{id}/tokens | Create a project token | Member bearer token |
| POST | /v1/projects/{id}/tokens/{tokenId}/revoke | Revoke a project token | Member bearer token |
| GET | /v1/sdk/config | Get SDK config for a project token | Project bearer token |
| GET | /v1/services | List services for a project | Member bearer token |
| GET | /v1/webhooks | List webhooks | Browser session, Member bearer token |
| POST | /v1/webhooks | Create a webhook | Browser session, Member bearer token |
| GET | /v1/webhooks/{id} | Get a webhook | Browser session, Member bearer token |
| PATCH | /v1/webhooks/{id} | Update a webhook | Browser session, Member bearer token |
| DELETE | /v1/webhooks/{id} | Delete a webhook | Browser session, Member bearer token |
| GET | /v1/webhooks/{id}/deliveries | List webhook deliveries | Browser session, Member bearer token |
| POST | /v1/webhooks/{id}/deliveries/{deliveryId}/retry | Retry a webhook delivery | Browser session, Member bearer token |
| POST | /v1/webhooks/{id}/test | Queue a synthetic webhook delivery | Browser session, Member bearer token |
| GET | /v1/weekly-report-channels | List weekly report channels | Browser session, Member bearer token |
| POST | /v1/weekly-report-channels | Create a weekly report channel | Browser session, Member bearer token |
| PATCH | /v1/weekly-report-channels/{id} | Update a weekly report channel | Browser session, Member bearer token |
| DELETE | /v1/weekly-report-channels/{id} | Delete a weekly report channel | Browser session, Member bearer token |