REST API
Core HTTP routes exposed by the API server. The Scalar reference is also available at /api/docs.
methodpathpurpose
GET/healthHealth, storage mode, subscriber count
POST/api/auth/registerCreate an email/password account, optionally from an invite
POST/api/auth/loginCreate a session token
POST/api/auth/password/forgotRequest a password reset email
POST/api/auth/password/resetReset password with token
GET/api/auth/meInspect current bearer token
GET/api/openapi.jsonOpenAPI 3.1 document
GET/api/docsScalar API reference
GET/api/api-keysList API keys for the current team
POST/api/api-keysCreate an API key; secret is returned once
DELETE/api/api-keys/:idRevoke an API key
GET/api/team/membersList team members and pending invites
POST/api/team/invitesInvite a team member
PATCH/api/team/members/:idUpdate a member role
GET/api/notifications/preferencesLoad email notification preferences
PATCH/api/notifications/preferencesUpdate email notification preferences
GET/api/notifications/eventsList notification events
GET/api/statsOverview metrics for the dashboard
POST/api/endpointsCreate a capture endpoint
GET/api/endpointsList endpoints
PATCH/api/endpoints/:tokenUpdate endpoint config
DELETE/api/endpoints/:tokenDelete endpoint and captured traffic
ANY/t/:token/*Capture webhook requests
GET/api/requestsSearch and filter captured requests
GET/api/requests/:idFetch a single captured request
GET/api/events/:tokenSSE live stream for an endpoint
POST/api/requests/:id/replayReplay a captured request
GET/api/replaysReplay history