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.
System
| Method | Path | Summary | Auth |
|---|
| GET | /health | Get service health | Public |
| GET | /live | Get liveness status | Public |
| GET | /ready | Get readiness status | Public |
Account
| Method | Path | Summary | Auth |
|---|
| DELETE | /v1/account | Delete the current organization account | Browser session |
| GET | /v1/account/avatar | Get the current account avatar image | Browser session |
| POST | /v1/account/avatar/import-gravatar | Import and cache a Gravatar avatar for the signed-in account | Browser session |
| POST | /v1/account/delete/request-otp | Request an email OTP for account deletion | Browser session |
| GET | /v1/account/export | Export retained organization account data | Browser session |
Alerts
| Method | Path | Summary | Auth |
|---|
| 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 |
Auth
| Method | Path | Summary | Auth |
|---|
| GET | /v1/auth/github/callback | Complete GitHub OAuth | Public |
| POST | /v1/auth/github/device/claim | Claim the member token issued by GitHub device login | Public |
| POST | /v1/auth/github/device/poll | Poll GitHub device login status | Public |
| POST | /v1/auth/github/device/start | Start GitHub device login | Public |
| GET | /v1/auth/github/start | Start GitHub OAuth | Public |
| POST | /v1/auth/github/token/exchange | Exchange a GitHub access token for a DebugBundle member token | Public |
| POST | /v1/auth/logout | Revoke the current browser session | Browser session |
| POST | /v1/auth/project-invite/accept | Accept a project invite | 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 |
Billing
| Method | Path | Summary | Auth |
|---|
| 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/checkout/confirm | Confirm a returned Stripe checkout session | Browser session |
| POST | /v1/billing/portal | Create a Stripe customer portal link | Browser session |
Ingestion
| Method | Path | Summary | Auth |
|---|
| POST | /v1/events | Ingest batched events | Project bearer token |
Improvements
| Method | Path | Summary | Auth |
|---|
| GET | /v1/improvements | List hosted improvement opportunities | Member bearer token |
| GET | /v1/improvements/{id} | Get a hosted improvement opportunity | Member bearer token |
| POST | /v1/improvements/{id}/reopen | Reopen a hosted improvement opportunity | Member bearer token |
| POST | /v1/improvements/{id}/resolve | Resolve a hosted improvement opportunity | Member bearer token |
| POST | /v1/improvements/{id}/snooze | Snooze a hosted improvement opportunity | Member bearer token |
| GET | /v1/projects/{id}/improvement-settings | Get automated improvement settings for a project | Browser session, Member bearer token |
| PATCH | /v1/projects/{id}/improvement-settings | Update automated improvement settings for a project | Browser session, Member bearer token |
| GET | /v1/projects/{id}/improvements/{improvementId}/bundle | Get the hosted bundle for an improvement opportunity | Browser session, Member bearer token |
Incidents
| Method | Path | Summary | Auth |
|---|
| GET | /v1/incidents | List incidents | Browser session, Member bearer token |
| GET | /v1/incidents/{id} | Get a single incident | Browser session, 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 | Browser session, Member bearer token |
| POST | /v1/incidents/reopen | Reopen incidents in bulk | Browser session, Member bearer token |
| POST | /v1/incidents/resolve | Resolve incidents in bulk | Browser session, Member bearer token |
| GET | /v1/logs | Query incident logs | Member bearer token |
Capture Rules
| Method | Path | Summary | Auth |
|---|
| POST | /v1/incidents/{id}/capture-rule-suggestion | Generate deterministic capture rule suggestions from an incident bundle | Browser session, Member bearer token |
| POST | /v1/incidents/{id}/capture-rules | Create a project capture rule from an incident suggestion | Browser session, Member bearer token |
| GET | /v1/projects/{id}/capture-rules | List project capture rules | Browser session, Member bearer token |
| POST | /v1/projects/{id}/capture-rules | Create a project capture rule | Browser session, Member bearer token |
| PATCH | /v1/projects/{id}/capture-rules/{ruleId} | Update a project capture rule | Browser session, Member bearer token |
| DELETE | /v1/projects/{id}/capture-rules/{ruleId} | Delete a project capture rule | Browser session, Member bearer token |
Tokens
| Method | Path | Summary | Auth |
|---|
| GET | /v1/member/tokens | List member tokens | Browser session, 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 | Browser session, Member bearer token |
| GET | /v1/projects/{id}/tokens | List project tokens | Browser session, Member bearer token |
| POST | /v1/projects/{id}/tokens | Create a project token | Browser session, Member bearer token |
| POST | /v1/projects/{id}/tokens/{tokenId}/revoke | Revoke a project token | Browser session, Member bearer token |
Projects
| Method | Path | Summary | Auth |
|---|
| 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 |
| POST | /v1/projects/{id}/invite | Invite a project member | Browser session, Member bearer token |
| GET | /v1/projects/{id}/invites | List pending project invites | Browser session, Member bearer token |
| DELETE | /v1/projects/{id}/invites/{inviteId} | Cancel a project invite | Browser session, Member bearer token |
| GET | /v1/projects/{id}/members | List project members | Browser session, Member bearer token |
| PATCH | /v1/projects/{id}/members/{userId} | Update a project member role | Browser session, Member bearer token |
| DELETE | /v1/projects/{id}/members/{userId} | Remove a project member | Browser session, Member bearer token |
| GET | /v1/projects/{id}/members/{userId}/avatar | Get a cached project member avatar image | Browser session, Member bearer token |
| DELETE | /v1/projects/{id}/membership | Leave a shared project | Browser session, Member bearer token |
Health
| Method | Path | Summary | Auth |
|---|
| GET | /v1/projects/{id}/availability-checks | List hosted health checks for a project | Browser session, Member bearer token |
| POST | /v1/projects/{id}/availability-checks | Create a hosted health check | Browser session, Member bearer token |
| GET | /v1/projects/{id}/availability-checks/{checkId} | Get one hosted health check | Browser session, Member bearer token |
| PATCH | /v1/projects/{id}/availability-checks/{checkId} | Update a hosted health check | Browser session, Member bearer token |
| DELETE | /v1/projects/{id}/availability-checks/{checkId} | Delete a hosted health check | Browser session, Member bearer token |
| GET | /v1/projects/{id}/availability-checks/{checkId}/daily-rollups | List retained per-day health-check history | Browser session, Member bearer token |
| GET | /v1/projects/{id}/availability-checks/{checkId}/results | List retained health-check execution results | Browser session, Member bearer token |
| POST | /v1/projects/{id}/availability-checks/test | Run a side-effect-free hosted health-check test | Browser session, Member bearer token |
Capture Policy
| Method | Path | Summary | Auth |
|---|
| 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 |
Probes
| Method | Path | Summary | Auth |
|---|
| 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 |
Slack
| Method | Path | Summary | Auth |
|---|
| GET | /v1/projects/{id}/slack/destinations | List reusable Slack destinations for a project organization | Browser session, Member bearer token |
| DELETE | /v1/projects/{id}/slack/destinations/{destinationId} | Delete a reusable Slack destination | Browser session, Member bearer token |
| POST | /v1/projects/{id}/slack/destinations/{destinationId}/test | Send a test message to a reusable Slack destination | Browser session, Member bearer token |
| GET | /v1/slack/app/callback | Complete the Slack OAuth install flow | Public |
| GET | /v1/slack/app/install-url | Create a Slack OAuth install URL | Browser session, Member bearer token |
SDK
| Method | Path | Summary | Auth |
|---|
| GET | /v1/sdk/config | Get SDK config for a project token | Project bearer token |
Services
| Method | Path | Summary | Auth |
|---|
| GET | /v1/services | List services for a project | Member bearer token |
Webhooks
| Method | Path | Summary | Auth |
|---|
| 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 |
Weekly Reports
| Method | Path | Summary | Auth |
|---|
| 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 |
