Reference/Endpoint index
Endpoint index
Every HTTP route the backend serves, generated from the router at build time.
Every route below is read out of backend/internal/handler/router.go when this
site is built. It is therefore never out of date with the deployed router — and
if it ever cannot be read, the build fails rather than shipping a stale list.
For how to authenticate, what the error shapes are, and which conventions apply to all of them, read API overview first.
Note
Role is the least privileged role that may call the endpoint. A blank
role means any authenticated member of the organisation. Every route is
scoped to the caller's organisation unless it is marked none under auth —
see Authentication.
1001 routes across 83 areas.
At a glance
| Area | Routes | Path |
|---|---|---|
| agents | 94 | /api/v1/agents |
| dwh | 86 | /api/v1/dwh |
| copilot | 57 | /api/v1/copilot |
| cloudflare | 47 | /api/v1/cloudflare |
| jenkins | 41 | /api/v1/jenkins |
| deployments | 40 | /api/v1/deployments |
| errors | 25 | /api/v1/errors |
| auth | 23 | /api/v1/auth |
| enterprise | 21 | /api/v1/enterprise |
| incidents | 20 | /api/v1/incidents |
| releases | 20 | /api/v1/releases |
| proxysql | 20 | /api/v1/proxysql |
| intelligent-alerts | 20 | /api/v1/intelligent-alerts |
| anomaly | 19 | /api/v1/anomaly |
| ga | 18 | /api/v1/ga |
| security | 17 | /api/v1/security |
| services | 16 | /api/v1/services |
| jira | 16 | /api/v1/jira |
| schedules | 15 | /api/v1/schedules |
| post-mortems | 15 | /api/v1/post-mortems |
| scim | 14 | /api/v1/scim |
| orgs | 14 | /api/v1/orgs |
| elk | 14 | /api/v1/elk |
| mysql | 12 | /api/v1/mysql |
| runbooks | 11 | /api/v1/runbooks |
| cost | 11 | /api/v1/cost |
| alert-rules | 10 | /api/v1/alert-rules |
| dashboards | 10 | /api/v1/dashboards |
| teams | 10 | /api/v1/teams |
| deploy-safety | 10 | /api/v1/deploy-safety |
| domain-health | 9 | /api/v1/domain-health |
| synthetic | 9 | /api/v1/synthetic |
| chaos | 9 | /api/v1/chaos |
| changes | 9 | /api/v1/changes |
| webhooks | 8 | /api/v1/webhooks |
| channels | 8 | /api/v1/channels |
| routing-rules | 8 | /api/v1/routing-rules |
| environments | 8 | /api/v1/environments |
| workflows | 8 | /api/v1/workflows |
| health | 7 | /api/v1/health |
| alerts | 7 | /api/v1/alerts |
| alert-templates | 7 | /api/v1/alert-templates |
| escalation-policies | 7 | /api/v1/escalation-policies |
| network | 7 | /api/v1/network |
| ingest | 6 | /api/v1/ingest |
| public | 6 | /api/v1/public |
| agent | 6 | /api/v1/agent |
| maintenance | 6 | /api/v1/maintenance |
| analytics | 6 | /api/v1/analytics |
| rules | 6 | /api/v1/rules |
| apm | 6 | /api/v1/apm |
| ab-configs | 6 | /api/v1/ab-configs |
| slos | 6 | /api/v1/slos |
| users | 5 | /api/v1/users |
| notifications | 5 | /api/v1/notifications |
| integrations | 5 | /api/v1/integrations |
| infisical | 5 | /api/v1/infisical |
| infra | 5 | /api/v1/infra |
| compliance | 5 | /api/v1/compliance |
| sdk | 4 | /api/v1/sdk |
| settings | 4 | /api/v1/settings |
| jobs | 4 | /api/v1/jobs |
| retention | 4 | /api/v1/retention |
| system-alert-config | 4 | /api/v1/system-alert-config |
| reports | 4 | /api/v1/reports |
| deploy | 3 | /api/v1/deploy |
| dependencies | 3 | /api/v1/dependencies |
| baselines | 3 | /api/v1/baselines |
| me | 3 | /api/v1/me |
| status-page | 3 | /api/v1/status-page |
| sso | 3 | /api/v1/sso |
| superset-proxy | 2 | /api/v1/superset-proxy |
| heartbeat | 2 | /api/v1/heartbeat |
| events | 2 | /api/v1/events |
| dashboard | 2 | /api/v1/dashboard |
| config | 2 | /api/v1/config |
| audit-logs | 2 | /api/v1/audit-logs |
| v1 | 1 | /api/v1/v1 |
| ab-config | 1 | /api/v1/ab-config |
| escalations | 1 | /api/v1/escalations |
| search | 1 | /api/v1/search |
| dependency-graph | 1 | /api/v1/dependency-graph |
| timeseries | 1 | /api/v1/timeseries |
agents
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/agents | any | agentHandler.List |
GET | /api/v1/agents/{id} | any | agentHandler.Get |
GET | /api/v1/agents/{id}/access | any | agentHandler.MyAccess |
GET | /api/v1/agents/{id}/checks | any | agentHandler.CheckStatus |
GET | /api/v1/agents/{id}/checks/{defID} | any | agentHandler.CheckHistory |
POST | /api/v1/agents/{id}/command | engineer | agentHandler.Dispatch |
GET | /api/v1/agents/{id}/commands | any | agentHandler.Commands |
GET | /api/v1/agents/{id}/commands/available | any | agentHandler.AgentCommandDefs |
POST | /api/v1/agents/{id}/config | engineer | agentHandler.SetConfig |
GET | /api/v1/agents/{id}/coverage | any | agentCollectorsHandler.Coverage |
POST | /api/v1/agents/{id}/coverage/apply | engineer | agentCollectorsHandler.ApplyCoverage |
GET | /api/v1/agents/{id}/detail | any | agentHandler.Detail |
GET | /api/v1/agents/{id}/file-states | any | agentCollectorsHandler.FileStates |
GET | /api/v1/agents/{id}/files | admin | agentHandler.FileList |
GET | /api/v1/agents/{id}/files/download | admin | agentHandler.FileDownload |
POST | /api/v1/agents/{id}/files/upload | admin | agentHandler.FileUpload |
GET | /api/v1/agents/{id}/health | any | agentCollectorsHandler.HealthBoard |
GET | /api/v1/agents/{id}/log-watches | any | agentCollectorsHandler.LogWatchStatus |
GET | /api/v1/agents/{id}/logs | any | agentHandler.Logs |
GET | /api/v1/agents/{id}/metrics | any | agentHandler.Metrics |
GET | /api/v1/agents/{id}/ports | any | agentHandler.ListenPorts |
POST | /api/v1/agents/{id}/ports/accept | engineer | agentCollectorsHandler.AcceptPorts |
GET | /api/v1/agents/{id}/ports/review | any | agentCollectorsHandler.PortReview |
GET | /api/v1/agents/{id}/processes | any | agentHandler.Processes |
GET | /api/v1/agents/{id}/scrape-series | any | agentCollectorsHandler.ScrapeSeries |
GET | /api/v1/agents/{id}/series | any | agentHandler.Series |
POST | /api/v1/agents/{id}/shell/input | admin | agentHandler.ShellInput |
GET | /api/v1/agents/{id}/shell/sessions | any | agentHandler.ShellSessions |
GET | /api/v1/agents/{id}/shell/sessions/{sessionID} | any | agentHandler.ShellTranscript |
POST | /api/v1/agents/{id}/shell/ticket | admin | agentHandler.ShellTicket |
GET | /api/v1/agents/access/history | admin | agentHandler.GrantHistory |
GET | /api/v1/agents/access/overview | admin | agentHandler.AccessOverview |
GET | /api/v1/agents/access/report | admin | agentHandler.AccessReport |
GET | /api/v1/agents/audit/verify | any | agentHandler.VerifyAudit |
GET | /api/v1/agents/collectors/library | any | agentCollectorsHandler.Library |
GET | /api/v1/agents/commands | any | agentHandler.ListCommandDefs |
POST | /api/v1/agents/commands | engineer | agentHandler.SaveCommandDef |
DELETE | /api/v1/agents/commands/{defID} | engineer | agentHandler.DeleteCommandDef |
PUT | /api/v1/agents/commands/{defID} | engineer | agentHandler.SaveCommandDef |
GET | /api/v1/agents/commands/library | any | agentHandler.CommandLibrary |
POST | /api/v1/agents/commands/preview | any | agentHandler.PreviewCommand |
GET | /api/v1/agents/coverage | any | agentCollectorsHandler.FleetCoverage |
GET | /api/v1/agents/coverage/catalog | any | agentCollectorsHandler.ServiceCatalog |
POST | /api/v1/agents/device/approve | admin | agentHandler.DeviceApprove |
GET | /api/v1/agents/drift | any | agentHandler.VersionDrift |
POST | /api/v1/agents/exec | engineer | agentHandler.FleetExec |
GET | /api/v1/agents/file-watches | any | agentCollectorsHandler.ListFileWatches |
POST | /api/v1/agents/file-watches | engineer | agentCollectorsHandler.SaveFileWatch |
DELETE | /api/v1/agents/file-watches/{watchID} | engineer | agentCollectorsHandler.DeleteFileWatch |
PUT | /api/v1/agents/file-watches/{watchID} | engineer | agentCollectorsHandler.SaveFileWatch |
GET | /api/v1/agents/grants | admin | agentHandler.ListGrants |
POST | /api/v1/agents/grants | admin | agentHandler.SaveGrant |
DELETE | /api/v1/agents/grants/{grantID} | admin | agentHandler.DeleteGrant |
PUT | /api/v1/agents/grants/{grantID} | admin | agentHandler.SaveGrant |
GET | /api/v1/agents/health-specs | any | agentCollectorsHandler.ListHealthSpecs |
POST | /api/v1/agents/health-specs | engineer | agentCollectorsHandler.SaveHealthSpec |
DELETE | /api/v1/agents/health-specs/{specID} | engineer | agentCollectorsHandler.DeleteHealthSpec |
GET | /api/v1/agents/log-watches | any | agentCollectorsHandler.ListLogWatches |
POST | /api/v1/agents/log-watches | engineer | agentCollectorsHandler.SaveLogWatch |
DELETE | /api/v1/agents/log-watches/{watchID} | engineer | agentCollectorsHandler.DeleteLogWatch |
PUT | /api/v1/agents/log-watches/{watchID} | engineer | agentCollectorsHandler.SaveLogWatch |
GET | /api/v1/agents/mesh | any | agentCollectorsHandler.Mesh |
GET | /api/v1/agents/observed | any | agentHandler.ObservedVersions |
GET | /api/v1/agents/probes | any | agentHandler.ListProbes |
POST | /api/v1/agents/probes | engineer | agentHandler.SaveProbe |
DELETE | /api/v1/agents/probes/{probeID} | engineer | agentHandler.DeleteProbe |
PUT | /api/v1/agents/probes/{probeID} | engineer | agentHandler.SaveProbe |
GET | /api/v1/agents/probes/{probeID}/results | any | agentHandler.ProbeResults |
GET | /api/v1/agents/probes/{probeID}/series | any | agentHandler.ProbeSeries |
GET | /api/v1/agents/rollouts | any | agentCollectorsHandler.ListRollouts |
POST | /api/v1/agents/rollouts | engineer | agentCollectorsHandler.StartRollout |
POST | /api/v1/agents/rollouts/{rolloutID}/halt | engineer | agentCollectorsHandler.HaltRollout |
GET | /api/v1/agents/rollouts/plan | any | agentCollectorsHandler.PlanRollout |
GET | /api/v1/agents/rules | any | agentHandler.ListRules |
POST | /api/v1/agents/rules | engineer | agentHandler.SaveRule |
DELETE | /api/v1/agents/rules/{ruleID} | engineer | agentHandler.DeleteRule |
PUT | /api/v1/agents/rules/{ruleID} | engineer | agentHandler.SaveRule |
GET | /api/v1/agents/rules/library | any | agentHandler.RuleLibrary |
GET | /api/v1/agents/scrapes | any | agentCollectorsHandler.ListScrapes |
POST | /api/v1/agents/scrapes | engineer | agentCollectorsHandler.SaveScrape |
DELETE | /api/v1/agents/scrapes/{specID} | engineer | agentCollectorsHandler.DeleteScrape |
PUT | /api/v1/agents/scrapes/{specID} | engineer | agentCollectorsHandler.SaveScrape |
GET | /api/v1/agents/silences | any | agentHandler.ListSilences |
POST | /api/v1/agents/silences | engineer | agentHandler.SaveSilence |
DELETE | /api/v1/agents/silences/{silenceID} | engineer | agentHandler.ExpireSilence |
PUT | /api/v1/agents/silences/{silenceID} | engineer | agentHandler.SaveSilence |
GET | /api/v1/agents/tokens | admin | agentHandler.ListTokens |
POST | /api/v1/agents/tokens | admin | agentHandler.CreateToken |
DELETE | /api/v1/agents/tokens/{id} | admin | agentHandler.RevokeToken |
dwh
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/dwh/alert-rules | any | dwhHandler.ListAlertRules |
POST | /api/v1/dwh/alert-rules | engineer | dwhHandler.CreateAlertRule |
DELETE | /api/v1/dwh/alert-rules/{id} | admin | dwhHandler.DeleteAlertRule |
PUT | /api/v1/dwh/alert-rules/{id} | engineer | dwhHandler.UpdateAlertRule |
GET | /api/v1/dwh/alert-rules/{id}/evaluations | any | dwhHandler.ListAlertRuleEvaluations |
POST | /api/v1/dwh/alert-rules/{id}/run | engineer | dwhHandler.RunAlertRuleNow |
POST | /api/v1/dwh/alert-rules/{id}/silence | engineer | dwhHandler.SilenceAlertRule |
GET | /api/v1/dwh/alert-rules/{id}/subjects | any | dwhHandler.RuleSubjects |
POST | /api/v1/dwh/alert-rules/{id}/test-fire | engineer | dwhHandler.TestFireAlertRule |
PATCH | /api/v1/dwh/alert-rules/{id}/toggle | engineer | dwhHandler.ToggleAlertRule |
GET | /api/v1/dwh/alert-rules/health | any | dwhHandler.RuleHealth |
POST | /api/v1/dwh/alert-rules/preview | engineer | dwhHandler.PreviewAlertRule |
GET | /api/v1/dwh/audit | any | dwhAdvancedHandler.Audit |
GET | /api/v1/dwh/connections | any | dwhHandler.ListConnections |
POST | /api/v1/dwh/connections | engineer | dwhHandler.CreateConnection |
DELETE | /api/v1/dwh/connections/{id} | admin | dwhHandler.DeleteConnection |
PUT | /api/v1/dwh/connections/{id} | engineer | dwhHandler.UpdateConnection |
GET | /api/v1/dwh/connections/{id}/databases | any | dwhHandler.ListConnectionDatabases |
POST | /api/v1/dwh/connections/{id}/query | engineer | dwhHandler.RunQuery |
GET | /api/v1/dwh/connections/{id}/schema | any | dwhHandler.ListConnectionSchema |
POST | /api/v1/dwh/connections/{id}/test | engineer | dwhHandler.TestConnection |
GET | /api/v1/dwh/cost | any | dwhAdvancedHandler.Cost |
GET | /api/v1/dwh/dashboards | any | dwhAdvancedHandler.ListDashboards |
POST | /api/v1/dwh/dashboards | engineer | dwhAdvancedHandler.CreateDashboard |
DELETE | /api/v1/dwh/dashboards/{id} | engineer | dwhAdvancedHandler.DeleteDashboard |
GET | /api/v1/dwh/dashboards/{id} | any | dwhAdvancedHandler.GetDashboard |
PATCH | /api/v1/dwh/dashboards/{id} | engineer | dwhAdvancedHandler.UpdateDashboard |
POST | /api/v1/dwh/dashboards/{id}/tiles | engineer | dwhAdvancedHandler.CreateTile |
DELETE | /api/v1/dwh/dashboards/{id}/tiles/{tileId} | engineer | dwhAdvancedHandler.DeleteTile |
PATCH | /api/v1/dwh/dashboards/{id}/tiles/{tileId} | engineer | dwhAdvancedHandler.UpdateTile |
POST | /api/v1/dwh/discover/databases | engineer | dwhHandler.DiscoverDatabases |
GET | /api/v1/dwh/lineage | any | dwhAdvancedHandler.Lineage |
GET | /api/v1/dwh/quality | any | dwhAdvancedHandler.ListQuality |
POST | /api/v1/dwh/quality | engineer | dwhAdvancedHandler.CreateQuality |
DELETE | /api/v1/dwh/quality/{id} | engineer | dwhAdvancedHandler.DeleteQuality |
GET | /api/v1/dwh/quality/{id} | any | dwhAdvancedHandler.GetQuality |
PATCH | /api/v1/dwh/quality/{id} | engineer | dwhAdvancedHandler.UpdateQuality |
POST | /api/v1/dwh/quality/{id}/run | engineer | dwhAdvancedHandler.RunQualityNow |
GET | /api/v1/dwh/quality/{id}/runs | any | dwhAdvancedHandler.ListQualityRuns |
GET | /api/v1/dwh/reports | any | saasReportHandler.List |
POST | /api/v1/dwh/reports | engineer | saasReportHandler.Create |
DELETE | /api/v1/dwh/reports/{id} | admin | saasReportHandler.Delete |
GET | /api/v1/dwh/reports/{id} | any | saasReportHandler.Get |
PUT | /api/v1/dwh/reports/{id} | engineer | saasReportHandler.Update |
POST | /api/v1/dwh/reports/{id}/run | engineer | saasReportHandler.Run |
GET | /api/v1/dwh/reports/{id}/runs | any | saasReportHandler.ListRuns |
POST | /api/v1/dwh/reports/{id}/test | engineer | saasReportHandler.Test |
GET | /api/v1/dwh/reports/{id}/versions | any | saasReportHandler.ListVersions |
POST | /api/v1/dwh/reports/{id}/versions/{versionId}/restore | engineer | saasReportHandler.RestoreVersion |
GET | /api/v1/dwh/reports/catalog | any | saasReportHandler.ListCatalog |
POST | /api/v1/dwh/reports/catalog | engineer | saasReportHandler.CreateCatalog |
DELETE | /api/v1/dwh/reports/catalog/{id} | engineer | saasReportHandler.DeleteCatalog |
PUT | /api/v1/dwh/reports/catalog/{id} | engineer | saasReportHandler.UpdateCatalog |
GET | /api/v1/dwh/reports/library | any | saasReportHandler.Library |
POST | /api/v1/dwh/reports/preview | engineer | saasReportHandler.Preview |
GET | /api/v1/dwh/reports/template | any | saasReportHandler.Template |
GET | /api/v1/dwh/saved-queries | any | dwhHandler.ListSavedQueries |
POST | /api/v1/dwh/saved-queries | engineer | dwhHandler.CreateSavedQuery |
DELETE | /api/v1/dwh/saved-queries/{id} | engineer | dwhHandler.DeleteSavedQuery |
PUT | /api/v1/dwh/saved-queries/{id} | engineer | dwhHandler.UpdateSavedQuery |
GET | /api/v1/dwh/scheduled | any | dwhAdvancedHandler.ListScheduled |
POST | /api/v1/dwh/scheduled | engineer | dwhAdvancedHandler.CreateScheduled |
DELETE | /api/v1/dwh/scheduled/{id} | engineer | dwhAdvancedHandler.DeleteScheduled |
GET | /api/v1/dwh/scheduled/{id} | any | dwhAdvancedHandler.GetScheduled |
PATCH | /api/v1/dwh/scheduled/{id} | engineer | dwhAdvancedHandler.UpdateScheduled |
POST | /api/v1/dwh/scheduled/{id}/run | engineer | dwhAdvancedHandler.RunScheduledNow |
GET | /api/v1/dwh/scheduled/{id}/runs | any | dwhAdvancedHandler.ListScheduledRuns |
GET | /api/v1/dwh/superset/charts | any | dwhHandler.ListSupersetCharts |
GET | /api/v1/dwh/superset/dashboards | any | dwhHandler.ListSupersetDashboards |
GET | /api/v1/dwh/superset/dashboards/{id}/datasets | any | dwhHandler.ListDashboardDatasets |
GET | /api/v1/dwh/superset/dashboards/{id}/filters | any | dwhHandler.GetDashboardFilters |
GET | /api/v1/dwh/superset/databases | any | dwhHandler.ListSupersetDatabases |
POST | /api/v1/dwh/superset/databases/discover | engineer | dwhHandler.DiscoverSupersetDatabases |
GET | /api/v1/dwh/superset/datasets | any | dwhHandler.ListSupersetDatasets |
GET | /api/v1/dwh/superset/datasets/{id} | any | dwhHandler.GetDatasetDetail |
POST | /api/v1/dwh/superset/datasets/{id}/data | engineer | dwhHandler.GetDatasetData |
POST | /api/v1/dwh/superset/guest-token | engineer | dwhHandler.SupersetGuestToken |
POST | /api/v1/dwh/superset/query | engineer | dwhHandler.SupersetQuery |
POST | /api/v1/dwh/tiles/{tileId}/run | any | dwhAdvancedHandler.RunTile |
copilot
| Method | Path | Role | Handler |
|---|---|---|---|
POST | /api/v1/copilot/actions/execute | engineer | copilotHandler.ExecuteAction |
GET | /api/v1/copilot/agents | engineer | copilotHandler.ListAgents |
POST | /api/v1/copilot/agents | admin | copilotHandler.CreateAgent |
DELETE | /api/v1/copilot/agents/{id} | admin | copilotHandler.DeleteAgent |
PUT | /api/v1/copilot/agents/{id} | admin | copilotHandler.UpdateAgent |
POST | /api/v1/copilot/agents/{id}/reset | admin | copilotHandler.ResetAgent |
GET | /api/v1/copilot/audit | admin | copilotHandler.ListAudit |
POST | /api/v1/copilot/chat | engineer | copilotHandler.Chat |
GET | /api/v1/copilot/conversations | engineer | copilotHandler.ListConversations |
DELETE | /api/v1/copilot/conversations/{id} | engineer | copilotHandler.DeleteConversation |
GET | /api/v1/copilot/conversations/{id} | engineer | copilotHandler.GetConversation |
PATCH | /api/v1/copilot/conversations/{id} | engineer | copilotHandler.RenameConversation |
GET | /api/v1/copilot/conversations/{id}/trace | engineer | copilotHandler.ConversationTrace |
GET | /api/v1/copilot/doc-sources | any | copilotHandler.ListDocSources |
POST | /api/v1/copilot/doc-sources | engineer | copilotHandler.CreateDocSource |
DELETE | /api/v1/copilot/doc-sources/{id} | engineer | copilotHandler.DeleteDocSource |
PATCH | /api/v1/copilot/doc-sources/{id} | engineer | copilotHandler.UpdateDocSource |
POST | /api/v1/copilot/doc-sources/{id}/crawl | engineer | copilotHandler.CrawlDocSource |
GET | /api/v1/copilot/doc-sources/{id}/runs | any | copilotHandler.ListDocRuns |
POST | /api/v1/copilot/feedback | engineer | copilotHandler.SubmitFeedback |
GET | /api/v1/copilot/github/repos | engineer | copilotHandler.ListGithubRepos |
GET | /api/v1/copilot/github/status | engineer | copilotHandler.GithubStatus |
POST | /api/v1/copilot/knowledge/learn | admin | copilotHandler.LearnKnowledge |
GET | /api/v1/copilot/knowledge/status | engineer | copilotHandler.KnowledgeStatus |
POST | /api/v1/copilot/knowledge/upload | admin | copilotHandler.UploadKBFile |
POST | /api/v1/copilot/max/connect | admin | copilotHandler.ConnectMax |
POST | /api/v1/copilot/max/disconnect | admin | copilotHandler.DisconnectMax |
GET | /api/v1/copilot/max/status | admin | copilotHandler.MaxAuthStatus |
POST | /api/v1/copilot/max/test | admin | copilotHandler.TestMaxAuth |
GET | /api/v1/copilot/mcp | admin | copilotHandler.ListMCPServers |
POST | /api/v1/copilot/mcp | admin | copilotHandler.CreateMCPServer |
DELETE | /api/v1/copilot/mcp/{id} | admin | copilotHandler.DeleteMCPServer |
PUT | /api/v1/copilot/mcp/{id} | admin | copilotHandler.UpdateMCPServer |
GET | /api/v1/copilot/memory | engineer | copilotHandler.ListMemory |
POST | /api/v1/copilot/memory | engineer | copilotHandler.AddMemory |
DELETE | /api/v1/copilot/memory/{id} | engineer | copilotHandler.DeleteMemory |
GET | /api/v1/copilot/models | any | copilotHandler.ListModels |
GET | /api/v1/copilot/pr-reviews | engineer | copilotHandler.ListPRReviews |
GET | /api/v1/copilot/pr-reviews/{id} | engineer | copilotHandler.GetPRReview |
POST | /api/v1/copilot/pr-reviews/{id}/findings/{idx} | engineer | copilotHandler.SetPRFindingStatus |
POST | /api/v1/copilot/pr-reviews/{id}/findings/{idx}/jira | engineer | copilotHandler.CreateJiraFromFinding |
POST | /api/v1/copilot/pr-reviews/auto | admin | copilotHandler.SetPRReviewAuto |
POST | /api/v1/copilot/pr-reviews/config | admin | copilotHandler.SetPRReviewConfig |
GET | /api/v1/copilot/pr-reviews/history | engineer | copilotHandler.PRReviewHistory |
POST | /api/v1/copilot/pr-reviews/review | engineer | copilotHandler.ReviewPR |
POST | /api/v1/copilot/pr-reviews/scan | engineer | copilotHandler.ScanPRReviews |
GET | /api/v1/copilot/pr-reviews/stats | engineer | copilotHandler.PRReviewStats |
POST | /api/v1/copilot/pr-reviews/webhook/rotate | admin | copilotHandler.RotatePRReviewWebhook |
POST | /api/v1/copilot/runs | engineer | copilotHandler.StartRun |
GET | /api/v1/copilot/runs/{id} | engineer | copilotHandler.GetRun |
POST | /api/v1/copilot/runs/{id}/cancel | engineer | copilotHandler.CancelRun |
GET | /api/v1/copilot/runs/{id}/events | engineer | copilotHandler.RunEvents |
GET | /api/v1/copilot/settings | any | copilotHandler.GetSettings |
PUT | /api/v1/copilot/settings | admin | copilotHandler.SaveSettings |
GET | /api/v1/copilot/settings/reveal | admin | copilotHandler.RevealSecret |
POST | /api/v1/copilot/slack/command | any | copilotHandler.SlackCommand |
GET | /api/v1/copilot/usage | engineer | copilotHandler.GetUsage |
cloudflare
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/cloudflare/alert-rules | any | datasourceAlertHandler.ListCFRules |
POST | /api/v1/cloudflare/alert-rules | engineer | datasourceAlertHandler.CreateCFRule |
DELETE | /api/v1/cloudflare/alert-rules/{id} | admin | datasourceAlertHandler.DeleteCFRule |
PUT | /api/v1/cloudflare/alert-rules/{id} | engineer | datasourceAlertHandler.UpdateCFRule |
PATCH | /api/v1/cloudflare/alert-rules/{id}/toggle | engineer | datasourceAlertHandler.ToggleCFRule |
GET | /api/v1/cloudflare/analytics | any | cloudflareHandler.GetAnalytics |
GET | /api/v1/cloudflare/bots | any | cloudflareHandler.GetBots |
GET | /api/v1/cloudflare/config | any | cloudflareHandler.GetConfig |
GET | /api/v1/cloudflare/dns | any | cloudflareHandler.GetDNS |
GET | /api/v1/cloudflare/endpoint-guards | any | cloudflareHandler.ListEndpointGuards |
PUT | /api/v1/cloudflare/endpoint-guards | engineer | cloudflareHandler.UpsertEndpointGuard |
DELETE | /api/v1/cloudflare/endpoint-guards/{id} | engineer | cloudflareHandler.DeleteEndpointGuard |
GET | /api/v1/cloudflare/endpoint-guards/{id}/baselines | any | cloudflareHandler.EndpointGuardBaselines |
DELETE | /api/v1/cloudflare/endpoint-guards/{id}/baselines/{baselineId} | engineer | cloudflareHandler.DeleteEndpointBaseline |
PATCH | /api/v1/cloudflare/endpoint-guards/{id}/baselines/{baselineId} | engineer | cloudflareHandler.UpdateEndpointBaseline |
GET | /api/v1/cloudflare/endpoint-guards/{id}/baselines/history | any | cloudflareHandler.EndpointBaselineHistory |
POST | /api/v1/cloudflare/endpoint-guards/{id}/baselines/learn | engineer | cloudflareHandler.LearnEndpointBaselines |
POST | /api/v1/cloudflare/endpoint-guards/{id}/evaluate | engineer | cloudflareHandler.EvaluateEndpointGuard |
GET | /api/v1/cloudflare/endpoint-guards/{id}/states | any | cloudflareHandler.EndpointGuardStates |
GET | /api/v1/cloudflare/endpoint-guards/{id}/triage | any | cloudflareHandler.EndpointTriageLog |
GET | /api/v1/cloudflare/endpoint-guards/{id}/triage/{entry} | any | cloudflareHandler.EndpointTriageEntry |
GET | /api/v1/cloudflare/export | any | cloudflareHandler.ExportAnalytics |
GET | /api/v1/cloudflare/firewall | any | cloudflareHandler.GetFirewall |
GET | /api/v1/cloudflare/history | any | cloudflareHandler.GetHistorySnapshot |
GET | /api/v1/cloudflare/history/range | any | cloudflareHandler.GetHistoryRange |
GET | /api/v1/cloudflare/latency-probe | admin | cloudflareHandler.LatencyProbe |
GET | /api/v1/cloudflare/lb-changes | any | cloudflareHandler.LBChanges |
POST | /api/v1/cloudflare/lb-changes/{id}/revert | engineer | cloudflareHandler.RevertLBChange |
POST | /api/v1/cloudflare/lb-poll | any | cloudflareHandler.LBPoll |
GET | /api/v1/cloudflare/load-balancers | any | cloudflareHandler.LoadBalancers |
PATCH | /api/v1/cloudflare/load-balancers/{lbId}/pool-weight | engineer | cloudflareHandler.SetPoolWeight |
GET | /api/v1/cloudflare/load-balancing/analytics | any | cloudflareHandler.LBAnalytics |
GET | /api/v1/cloudflare/load-balancing/analytics/geo | any | cloudflareHandler.LBGeo |
GET | /api/v1/cloudflare/load-balancing/analytics/routing | any | cloudflareHandler.LBRouting |
GET | /api/v1/cloudflare/overview | any | cloudflareHandler.GetOverview |
PATCH | /api/v1/cloudflare/pools/{poolId}/origins | engineer | cloudflareHandler.SetOriginWeight |
GET | /api/v1/cloudflare/rollup | any | cloudflareHandler.GetRollup |
GET | /api/v1/cloudflare/rum | any | cloudflareHandler.GetRUM |
GET | /api/v1/cloudflare/saved-inspectors | any | cfSavedInspectorHandler.List |
POST | /api/v1/cloudflare/saved-inspectors | engineer | cfSavedInspectorHandler.Create |
DELETE | /api/v1/cloudflare/saved-inspectors/{id} | engineer | cfSavedInspectorHandler.Delete |
POST | /api/v1/cloudflare/test-connection | engineer | cloudflareHandler.TestConnection |
GET | /api/v1/cloudflare/url-inspector | any | cloudflareHandler.GetURLInspector |
GET | /api/v1/cloudflare/workers | any | cloudflareHandler.GetWorkers |
GET | /api/v1/cloudflare/zone | any | cloudflareHandler.GetZone |
jenkins
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/jenkins/builds | any | jenkinsHandler.ListRecentBuilds |
GET | /api/v1/jenkins/dora | any | jenkinsHandler.DORA |
GET | /api/v1/jenkins/gate | any | jenkinsHandler.Gate |
GET | /api/v1/jenkins/inbox | any | jenkinsHandler.ApprovalInbox |
GET | /api/v1/jenkins/integrations | any | jenkinsHandler.ListIntegrations |
POST | /api/v1/jenkins/integrations | engineer | jenkinsHandler.CreateIntegration |
DELETE | /api/v1/jenkins/integrations/{id} | admin | jenkinsHandler.DeleteIntegration |
PATCH | /api/v1/jenkins/integrations/{id} | engineer | jenkinsHandler.UpdateIntegration |
GET | /api/v1/jenkins/integrations/{id}/automap-preview | any | jenkinsHandler.AutoMapPreview |
GET | /api/v1/jenkins/integrations/{id}/branches | any | jenkinsHandler.Branches |
GET | /api/v1/jenkins/integrations/{id}/builds | any | jenkinsHandler.ListBuildsByJob |
POST | /api/v1/jenkins/integrations/{id}/builds/{num}/abort | engineer | jenkinsHandler.AbortBuild |
POST | /api/v1/jenkins/integrations/{id}/builds/{num}/approve | engineer | jenkinsHandler.ApproveInput |
GET | /api/v1/jenkins/integrations/{id}/builds/{num}/artifacts | any | jenkinsHandler.BuildArtifacts |
GET | /api/v1/jenkins/integrations/{id}/builds/{num}/changes | any | jenkinsHandler.BuildChanges |
GET | /api/v1/jenkins/integrations/{id}/builds/{num}/console | any | jenkinsHandler.ConsoleLog |
POST | /api/v1/jenkins/integrations/{id}/builds/{num}/description | engineer | jenkinsHandler.SetBuildDescription |
GET | /api/v1/jenkins/integrations/{id}/builds/{num}/explain | any | jenkinsHandler.ExplainFailure |
POST | /api/v1/jenkins/integrations/{id}/builds/{num}/rebuild | engineer | jenkinsHandler.Rebuild |
POST | /api/v1/jenkins/integrations/{id}/builds/{num}/refresh | any | jenkinsHandler.RefreshBuild |
GET | /api/v1/jenkins/integrations/{id}/builds/{num}/stages | any | jenkinsHandler.BuildStages |
GET | /api/v1/jenkins/integrations/{id}/builds/{num}/tests | any | jenkinsHandler.TestReport |
GET | /api/v1/jenkins/integrations/{id}/compare-builds | any | jenkinsHandler.CompareBuilds |
GET | /api/v1/jenkins/integrations/{id}/job-analytics | any | jenkinsHandler.JobAnalytics |
POST | /api/v1/jenkins/integrations/{id}/job-enabled | engineer | jenkinsHandler.SetJobEnabled |
GET | /api/v1/jenkins/integrations/{id}/job-parameters | any | jenkinsHandler.JobParameters |
GET | /api/v1/jenkins/integrations/{id}/jobs | any | jenkinsHandler.ListJobs |
GET | /api/v1/jenkins/integrations/{id}/nodes | any | jenkinsHandler.Nodes |
GET | /api/v1/jenkins/integrations/{id}/queue | any | jenkinsHandler.Queue |
GET | /api/v1/jenkins/integrations/{id}/scheduled | any | jenkinsHandler.ScheduledJobs |
POST | /api/v1/jenkins/integrations/{id}/sync | engineer | jenkinsHandler.SyncJobs |
POST | /api/v1/jenkins/integrations/{id}/test | any | jenkinsHandler.TestConnection |
POST | /api/v1/jenkins/integrations/{id}/trigger | engineer | jenkinsHandler.TriggerJob |
POST | /api/v1/jenkins/integrations/test | engineer | jenkinsHandler.TestNewConnection |
GET | /api/v1/jenkins/jobs | any | jenkinsHandler.ListAllJobs |
GET | /api/v1/jenkins/mappings | any | jenkinsHandler.ListMappings |
POST | /api/v1/jenkins/mappings | engineer | jenkinsHandler.UpsertMapping |
DELETE | /api/v1/jenkins/mappings/{id} | engineer | jenkinsHandler.DeleteMapping |
POST | /api/v1/jenkins/notify/{id} | any | jenkinsHandler.Notify |
POST | /api/v1/jenkins/services/{id}/{role} | engineer | jenkinsHandler.DeployForService |
GET | /api/v1/jenkins/services/{id}/builds | any | jenkinsHandler.ListBuildsByService |
deployments
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/deployments | any | deploymentHandler.List |
DELETE | /api/v1/deployments/annotations/{id} | engineer | releaseAnalyticsHandler.DeleteAnnotation |
GET | /api/v1/deployments/approval-settings | any | deploySafetyHandler.GetApprovalSettings |
PUT | /api/v1/deployments/approval-settings | admin | deploySafetyHandler.UpdateApprovalSettings |
GET | /api/v1/deployments/approvals | any | deploySafetyHandler.ListApprovals |
POST | /api/v1/deployments/approvals | engineer | deploySafetyHandler.RequestApproval |
POST | /api/v1/deployments/approvals/{id}/decide | admin | deploySafetyHandler.DecideApproval |
GET | /api/v1/deployments/compare | any | releaseAnalyticsHandler.Compare |
GET | /api/v1/deployments/env-matrix | any | releaseAnalyticsHandler.EnvMatrix |
GET | /api/v1/deployments/fleet | any | deployFleetHandler.View |
POST | /api/v1/deployments/fleet/runs/{id}/known-bad | engineer | deployFleetHandler.MarkRun |
POST | /api/v1/deployments/fleet/targets | admin | deployFleetHandler.UpsertTarget |
DELETE | /api/v1/deployments/fleet/targets/{id} | admin | deployFleetHandler.DeleteTarget |
POST | /api/v1/deployments/fleet/targets/{id}/rollback | engineer | deployFleetHandler.Rollback |
GET | /api/v1/deployments/fleet/targets/{id}/runs | any | deployFleetHandler.TargetHistory |
GET | /api/v1/deployments/heatmap | any | releaseAnalyticsHandler.Heatmap |
GET | /api/v1/deployments/last-good | any | releaseAnalyticsHandler.LastGood |
GET | /api/v1/deployments/pipeline-setup | any | pipelinePickerHandler.List |
PUT | /api/v1/deployments/pipeline-setup | engineer | pipelinePickerHandler.SetMarks |
POST | /api/v1/deployments/pipeline-setup/sync | engineer | pipelinePickerHandler.Resync |
GET | /api/v1/deployments/pipelines | any | deployPipelineHandler.ListPipelines |
POST | /api/v1/deployments/pipelines | engineer | deployPipelineHandler.CreatePipeline |
DELETE | /api/v1/deployments/pipelines/{id} | admin | deployPipelineHandler.DeletePipeline |
GET | /api/v1/deployments/pipelines/{id} | any | deployPipelineHandler.GetPipeline |
PUT | /api/v1/deployments/pipelines/{id} | engineer | deployPipelineHandler.UpdatePipeline |
POST | /api/v1/deployments/pipelines/{id}/run | engineer | deployPipelineHandler.RunPipeline |
GET | /api/v1/deployments/regression | any | releaseAnalyticsHandler.Regression |
GET | /api/v1/deployments/runs | any | deployPipelineHandler.ListRuns |
GET | /api/v1/deployments/runs/{id} | any | deployPipelineHandler.GetRun |
POST | /api/v1/deployments/runs/{id}/cancel | engineer | deployPipelineHandler.CancelRun |
POST | /api/v1/deployments/runs/{id}/promote | engineer | deployPipelineHandler.PromoteRun |
GET | /api/v1/deployments/setup | any | deploySetupHandler.Report |
GET | /api/v1/deployments/setup/classify-pipelines | any | deploySetupHandler.ClassifyPipelines |
POST | /api/v1/deployments/setup/classify-pipelines | admin | deploySetupHandler.ClassifyPipelines |
GET | /api/v1/deployments/setup/confirm-servers | any | deploySetupHandler.ConfirmServers |
POST | /api/v1/deployments/setup/confirm-servers | admin | deploySetupHandler.ConfirmServers |
GET | /api/v1/deployments/setup/detect-environments | any | deploySetupHandler.DetectEnvironments |
POST | /api/v1/deployments/setup/detect-environments | admin | deploySetupHandler.DetectEnvironments |
POST | /api/v1/deployments/setup/dismiss | admin | deploySetupHandler.Dismiss |
errors
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/errors/correlations | any | errorPatternHandler.ListCorrelations |
POST | /api/v1/errors/events | engineer | errorTrackingHandler.Ingest |
GET | /api/v1/errors/ingest-keys | admin | webIngestKeyHandler.List |
POST | /api/v1/errors/ingest-keys | admin | webIngestKeyHandler.Create |
DELETE | /api/v1/errors/ingest-keys/{id} | admin | webIngestKeyHandler.Revoke |
GET | /api/v1/errors/issues | any | errorTrackingHandler.ListIssues |
GET | /api/v1/errors/issues/{id} | any | errorTrackingHandler.GetIssue |
PATCH | /api/v1/errors/issues/{id} | engineer | errorTrackingHandler.UpdateIssue |
GET | /api/v1/errors/issues/{id}/affected-users | any | errorTrackingHandler.AffectedUsers |
GET | /api/v1/errors/issues/{id}/comments | any | errorTrackingHandler.ListComments |
POST | /api/v1/errors/issues/{id}/comments | engineer | errorTrackingHandler.AddComment |
GET | /api/v1/errors/issues/{id}/releases | any | errorTrackingHandler.ReleaseBreakdown |
GET | /api/v1/errors/issues/{id}/trace | any | errorTrackingHandler.GetTrace |
POST | /api/v1/errors/issues/bulk | engineer | errorTrackingHandler.BulkUpdate |
GET | /api/v1/errors/network-failures | any | networkFailuresHandler.Get |
GET | /api/v1/errors/patterns | any | errorPatternHandler.List |
POST | /api/v1/errors/patterns | engineer | errorPatternHandler.Create |
DELETE | /api/v1/errors/patterns/{id} | engineer | errorPatternHandler.Delete |
GET | /api/v1/errors/patterns/{id} | any | errorPatternHandler.Get |
PUT | /api/v1/errors/patterns/{id} | engineer | errorPatternHandler.Update |
POST | /api/v1/errors/patterns/{id}/rescan | engineer | errorPatternHandler.Rescan |
GET | /api/v1/errors/release-diff | any | errorTrackingHandler.ReleaseErrors |
GET | /api/v1/errors/sourcemaps | any | errorTrackingHandler.ListSourceMaps |
DELETE | /api/v1/errors/sourcemaps/{id} | engineer | errorTrackingHandler.DeleteSourceMap |
auth
| Method | Path | Role | Handler |
|---|---|---|---|
DELETE | /api/v1/auth/2fa | any | authHandler.Disable2FA |
POST | /api/v1/auth/2fa/complete | any | authHandler.Complete2FALogin |
POST | /api/v1/auth/2fa/setup | any | authHandler.Setup2FA |
GET | /api/v1/auth/2fa/status | any | authHandler.Get2FAStatus |
POST | /api/v1/auth/2fa/verify | any | authHandler.Verify2FA |
POST | /api/v1/auth/change-password | any | authHandler.ChangePassword |
POST | /api/v1/auth/forgot-password | public | authHandler.ForgotPassword |
POST | /api/v1/auth/invite/{token} | any | orgHandler.AcceptInvitation |
POST | /api/v1/auth/login | public | authHandler.Login |
POST | /api/v1/auth/logout | public | authHandler.Logout |
GET | /api/v1/auth/me | any | authHandler.Me |
POST | /api/v1/auth/refresh | any | authHandler.Refresh |
POST | /api/v1/auth/reset-password | public | authHandler.ResetPassword |
POST | /api/v1/auth/select-org | any | authHandler.SelectOrg |
POST | /api/v1/auth/signup | public | orgHandler.Signup |
GET | /api/v1/auth/slack | public | slackOAuthHandler.SlackLogin |
GET | /api/v1/auth/slack/callback | public | slackOAuthHandler.SlackCallback |
GET | /api/v1/auth/sso | public | ssoHandler.Login |
GET | /api/v1/auth/sso/callback | public | ssoHandler.Callback |
GET, POST | /api/v1/auth/verify-email | any | securityHardeningHandler.VerifyEmail |
enterprise
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/enterprise/approvals | any | enterpriseHandler.ListApprovals |
POST | /api/v1/enterprise/approvals | any | enterpriseHandler.CreateApproval |
POST | /api/v1/enterprise/approvals/{id}/decide | admin | enterpriseHandler.DecideApproval |
GET | /api/v1/enterprise/dpa | any | enterpriseHandler.DPATemplate |
POST | /api/v1/enterprise/dpa/sign | owner | enterpriseHandler.SignDPA |
GET | /api/v1/enterprise/org-security | admin | enterpriseHandler.GetOrgSecurity |
PUT | /api/v1/enterprise/org-security | admin | enterpriseHandler.UpdateOrgSecurity |
GET | /api/v1/enterprise/roles | admin | enterpriseHandler.ListRoles |
POST | /api/v1/enterprise/roles | admin | enterpriseHandler.CreateRole |
DELETE | /api/v1/enterprise/roles/{id} | admin | enterpriseHandler.DeleteRole |
PATCH | /api/v1/enterprise/roles/{id} | admin | enterpriseHandler.UpdateRole |
DELETE | /api/v1/enterprise/roles/{roleId}/users/{userId} | admin | enterpriseHandler.UnassignRole |
POST | /api/v1/enterprise/roles/assign | admin | enterpriseHandler.AssignRole |
GET | /api/v1/enterprise/sub-processors | any | enterpriseHandler.ListSubProcessors |
POST | /api/v1/enterprise/sub-processors | admin | enterpriseHandler.UpsertSubProcessor |
DELETE | /api/v1/enterprise/sub-processors/{id} | admin | enterpriseHandler.DeleteSubProcessor |
PUT | /api/v1/enterprise/sub-processors/{id} | admin | enterpriseHandler.UpsertSubProcessor |
GET | /api/v1/enterprise/tokens | admin | enterpriseHandler.ListTokens |
POST | /api/v1/enterprise/tokens | admin | enterpriseHandler.CreateToken |
DELETE | /api/v1/enterprise/tokens/{id} | admin | enterpriseHandler.RevokeToken |
POST | /api/v1/enterprise/users/{userId}/force-logout | admin | enterpriseHandler.ForceLogout |
incidents
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/incidents | any | incidentHandler.List |
POST | /api/v1/incidents | engineer | incidentHandler.Create |
GET | /api/v1/incidents/{id} | any | incidentHandler.GetByID |
PATCH | /api/v1/incidents/{id} | engineer | incidentHandler.Update |
GET | /api/v1/incidents/{id}/attribution | any | releaseAnalyticsHandler.Attribution |
GET | /api/v1/incidents/{id}/escalation | any | escalationHandler.GetEscalationStatus |
POST | /api/v1/incidents/{id}/escalation/ack | engineer | escalationHandler.AckEscalation |
GET | /api/v1/incidents/{id}/escalation/timeline | any | escAnalyticsHandler.GetTimeline |
POST | /api/v1/incidents/{id}/events | engineer | incidentHandler.AddEvent |
GET | /api/v1/incidents/{id}/post-mortems | any | pmHandler.ListByIncident |
GET | /api/v1/incidents/{id}/roles | any | incidentHandler.ListRoles |
POST | /api/v1/incidents/{id}/roles | engineer | incidentHandler.AssignRole |
DELETE | /api/v1/incidents/{id}/roles/{userId} | engineer | incidentHandler.RemoveRole |
GET | /api/v1/incidents/{id}/runbook-runs | any | runbookHandler.ListRunsByIncident |
GET | /api/v1/incidents/{id}/runbook-suggestions | any | runbookHandler.Suggestions |
POST | /api/v1/incidents/{id}/war-room/heartbeat | any | incidentHandler.WarRoomHeartbeat |
GET | /api/v1/incidents/{id}/war-room/presence | any | incidentHandler.WarRoomPresence |
GET | /api/v1/incidents/stats | any | incidentHandler.Stats |
releases
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/releases | any | releaseHandler.List |
POST | /api/v1/releases | engineer | releaseHandler.Create |
GET | /api/v1/releases/{id:[0-9a-fA-F-]{36}} | any | releaseHandler.Get |
GET | /api/v1/releases/{id:[0-9a-fA-F-]{36}}/changelog | any | releaseHandler.Changelog |
POST | /api/v1/releases/{id:[0-9a-fA-F-]{36}}/deploy | engineer | releaseHandler.Deploy |
DELETE | /api/v1/releases/{id:[0-9a-fA-F-]{36}}/deployments/{depId} | engineer | releaseHandler.UnlinkDeployment |
POST | /api/v1/releases/{id:[0-9a-fA-F-]{36}}/deployments/{depId} | engineer | releaseHandler.LinkDeployment |
POST | /api/v1/releases/{id:[0-9a-fA-F-]{36}}/pipeline | engineer | releaseHandler.SetPipeline |
POST | /api/v1/releases/{id:[0-9a-fA-F-]{36}}/released | engineer | releaseHandler.MarkReleased |
POST | /api/v1/releases/{id:[0-9a-fA-F-]{36}}/snapshot | engineer | releaseHandler.Snapshot |
GET | /api/v1/releases/audit-ledger | any | releaseAnalyticsHandler.AuditLedger |
GET | /api/v1/releases/changelog | any | deploySafetyHandler.ReleaseChangelog |
GET | /api/v1/releases/config | any | releaseHandler.GetConfig |
PUT | /api/v1/releases/config | engineer | releaseHandler.UpdateConfig |
GET | /api/v1/releases/dora | any | deploySafetyHandler.ReleaseDORA |
GET | /api/v1/releases/notify-config | any | deploySafetyHandler.ListReleaseNotify |
PUT | /api/v1/releases/notify-config | engineer | deploySafetyHandler.UpsertReleaseNotify |
DELETE | /api/v1/releases/notify-config/{env} | engineer | deploySafetyHandler.DeleteReleaseNotify |
POST | /api/v1/releases/sync | engineer | releaseHandler.Sync |
GET | /api/v1/releases/timeline | any | deploySafetyHandler.ReleaseTimeline |
proxysql
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/proxysql/{id}/actions | any | proxysqlHandler.ListActions |
POST | /api/v1/proxysql/{id}/actions | admin | proxysqlHandler.ProposeAction |
POST | /api/v1/proxysql/{id}/actions/{aid}/confirm | admin | proxysqlHandler.ConfirmAction |
GET | /api/v1/proxysql/{id}/drift | any | proxysqlHandler.Drift |
GET | /api/v1/proxysql/{id}/errors | any | proxysqlHandler.Errors |
GET | /api/v1/proxysql/{id}/latency | any | proxysqlHandler.Latency |
GET | /api/v1/proxysql/{id}/lint | any | proxysqlHandler.Lint |
GET | /api/v1/proxysql/{id}/live | engineer | proxysqlHandler.Live |
GET | /api/v1/proxysql/{id}/monitor | any | proxysqlHandler.Monitor |
GET | /api/v1/proxysql/{id}/queries | any | proxysqlHandler.TopQueries |
GET | /api/v1/proxysql/{id}/timeline | any | proxysqlHandler.Timeline |
GET | /api/v1/proxysql/{id}/write-probe | any | proxysqlHandler.WriteProbe |
POST | /api/v1/proxysql/{id}/write-probe/test | engineer | proxysqlHandler.TestWriteProbe |
GET | /api/v1/proxysql/actions | any | proxysqlHandler.ListActions |
GET | /api/v1/proxysql/actions/verify | any | proxysqlHandler.VerifyLedger |
GET | /api/v1/proxysql/cluster | any | proxysqlHandler.Cluster |
GET | /api/v1/proxysql/failover | any | proxysqlHandler.Failover |
GET | /api/v1/proxysql/overview | any | proxysqlHandler.Overview |
GET | /api/v1/proxysql/shun-history | any | proxysqlHandler.ShunHistory |
POST | /api/v1/proxysql/test-connection | engineer | proxysqlHandler.TestConnection |
intelligent-alerts
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/intelligent-alerts/analytics | any | intelligentAlertingHandler.GetAlertAnalytics |
GET | /api/v1/intelligent-alerts/anomalies | any | intelligentAlertingHandler.GetAnomalies |
POST | /api/v1/intelligent-alerts/anomalies/detect | engineer | intelligentAlertingHandler.DetectAnomalies |
GET | /api/v1/intelligent-alerts/config | any | intelligentAlertingHandler.GetAlertConfiguration |
PUT | /api/v1/intelligent-alerts/config | admin | intelligentAlertingHandler.UpdateAlertConfiguration |
GET | /api/v1/intelligent-alerts/correlations | any | intelligentAlertingHandler.GetAlertCorrelations |
GET | /api/v1/intelligent-alerts/feedback | any | intelligentAlertingHandler.GetAlertFeedback |
POST | /api/v1/intelligent-alerts/feedback | engineer | intelligentAlertingHandler.SubmitFeedback |
GET | /api/v1/intelligent-alerts/groups | any | intelligentAlertingHandler.GetAlertGroups |
POST | /api/v1/intelligent-alerts/groups | engineer | intelligentAlertingHandler.CreateAlertGroup |
DELETE | /api/v1/intelligent-alerts/groups/{id} | admin | intelligentAlertingHandler.DeleteAlertGroup |
PATCH | /api/v1/intelligent-alerts/groups/{id} | engineer | intelligentAlertingHandler.UpdateAlertGroup |
GET | /api/v1/intelligent-alerts/metrics | any | intelligentAlertingHandler.GetAlertMetrics |
GET | /api/v1/intelligent-alerts/patterns | any | intelligentAlertingHandler.GetAlertPatterns |
GET | /api/v1/intelligent-alerts/suppression-rules | any | intelligentAlertingHandler.GetSuppressionRules |
POST | /api/v1/intelligent-alerts/suppression-rules | engineer | intelligentAlertingHandler.CreateSuppressionRule |
DELETE | /api/v1/intelligent-alerts/suppression-rules/{id} | engineer | intelligentAlertingHandler.DeleteSuppressionRule |
PUT | /api/v1/intelligent-alerts/suppression-rules/{id} | engineer | intelligentAlertingHandler.UpdateSuppressionRule |
GET | /api/v1/intelligent-alerts/trends | any | intelligentAlertingHandler.GetAlertTrends |
anomaly
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/anomaly/backtest | any | anomalyHandler.Backtest |
GET | /api/v1/anomaly/baselines | any | anomalyHandler.ListBaselines |
GET | /api/v1/anomaly/baselines/{source}/{key} | any | anomalyHandler.GetBaseline |
POST | /api/v1/anomaly/bootstrap | engineer | anomalyHandler.Bootstrap |
GET | /api/v1/anomaly/detections | any | anomalyHandler.ListDetections |
POST | /api/v1/anomaly/detections/{id}/ack | any | anomalyHandler.AckDetection |
POST | /api/v1/anomaly/detections/{id}/feedback | any | anomalyHandler.Feedback |
GET | /api/v1/anomaly/engine-settings | any | anomalyHandler.GetEngineSettings |
POST | /api/v1/anomaly/engine-settings | engineer | anomalyHandler.UpsertEngineSettings |
GET | /api/v1/anomaly/forecast | any | anomalyHandler.Forecast |
GET | /api/v1/anomaly/groups | any | anomalyHandler.ListGroups |
GET | /api/v1/anomaly/maturity/{source}/{key} | any | anomalyHandler.GetMaturity |
GET | /api/v1/anomaly/recommendations | any | anomalyHandler.ListRecommendations |
POST | /api/v1/anomaly/recommendations/{id}/accept | engineer | anomalyHandler.AcceptRecommendation |
POST | /api/v1/anomaly/recommendations/{id}/reject | engineer | anomalyHandler.RejectRecommendation |
POST | /api/v1/anomaly/scan | engineer | anomalyHandler.RunScan |
GET | /api/v1/anomaly/scan/runs | any | anomalyHandler.ListScanRuns |
GET | /api/v1/anomaly/settings | any | anomalyHandler.ListSettings |
POST | /api/v1/anomaly/settings | engineer | anomalyHandler.UpsertSettings |
ga
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/ga/alert-rules | any | datasourceAlertHandler.ListGARules |
POST | /api/v1/ga/alert-rules | engineer | datasourceAlertHandler.CreateGARule |
DELETE | /api/v1/ga/alert-rules/{id} | admin | datasourceAlertHandler.DeleteGARule |
PUT | /api/v1/ga/alert-rules/{id} | engineer | datasourceAlertHandler.UpdateGARule |
PATCH | /api/v1/ga/alert-rules/{id}/toggle | engineer | datasourceAlertHandler.ToggleGARule |
GET | /api/v1/ga/annotations | any | gaHandler.GAAnnotations |
POST | /api/v1/ga/annotations | engineer | gaHandler.GACreateAnnotation |
DELETE | /api/v1/ga/annotations/{id} | engineer | gaHandler.GADeleteAnnotation |
GET | /api/v1/ga/cohort | any | gaHandler.GACohort |
DELETE | /api/v1/ga/connect | admin | gaHandler.GADisconnect |
POST | /api/v1/ga/connect | admin | gaHandler.GAConnect |
POST | /api/v1/ga/funnel | any | gaHandler.GAFunnel |
GET | /api/v1/ga/metadata | any | gaHandler.GAMetadata |
GET | /api/v1/ga/overview | any | gaHandler.GAOverview |
GET | /api/v1/ga/pivot | any | gaHandler.GAPivot |
GET | /api/v1/ga/realtime | any | gaHandler.GARealtime |
GET | /api/v1/ga/report | any | gaHandler.GAReport |
GET | /api/v1/ga/status | any | gaHandler.GAStatus |
security
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/security/audit/verify | admin | securityHardeningHandler.VerifyAuditChain |
GET | /api/v1/security/backup-codes | any | securityHardeningHandler.BackupCodeStatus |
POST | /api/v1/security/backup-codes | any | securityHardeningHandler.GenerateBackupCodes |
POST | /api/v1/security/csp-report | any | securityHardeningHandler.CSPReport |
GET | /api/v1/security/csp-violations | admin | securityHardeningHandler.ListCSPViolations |
GET | /api/v1/security/findings | any | securityHandler.List |
POST | /api/v1/security/findings | engineer | securityHandler.Ingest |
PATCH | /api/v1/security/findings/{id}/status | engineer | securityHandler.UpdateStatus |
POST | /api/v1/security/password-check | any | securityHardeningHandler.CheckPassword |
POST | /api/v1/security/verify-email/resend | any | securityHardeningHandler.ResendEmailVerification |
GET | /api/v1/security/webauthn/credentials | any | securityHardeningHandler.WebAuthnListCreds |
DELETE | /api/v1/security/webauthn/credentials/{id} | any | securityHardeningHandler.WebAuthnDelete |
POST | /api/v1/security/webauthn/login/begin | any | securityHardeningHandler.WebAuthnBeginLogin |
POST | /api/v1/security/webauthn/login/finish | any | securityHardeningHandler.WebAuthnFinishLogin |
POST | /api/v1/security/webauthn/register/begin | any | securityHardeningHandler.WebAuthnBeginRegister |
POST | /api/v1/security/webauthn/register/finish | any | securityHardeningHandler.WebAuthnFinishRegister |
services
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/services | any | serviceHandler.List |
POST | /api/v1/services | engineer | serviceHandler.Create |
DELETE | /api/v1/services/{id} | admin | serviceHandler.Delete |
GET | /api/v1/services/{id} | any | serviceHandler.GetByID |
PUT | /api/v1/services/{id} | engineer | serviceHandler.Update |
POST | /api/v1/services/{id}/check | engineer | serviceHandler.CheckNow |
GET | /api/v1/services/{id}/checks | any | serviceHandler.ListChecks |
GET | /api/v1/services/{id}/deployments | any | deploymentHandler.ListByService |
GET | /api/v1/services/{id}/latency | any | serviceHandler.GetLatency |
GET | /api/v1/services/{id}/location-status | any | serviceHandler.GetLocationStatus |
GET | /api/v1/services/{id}/rules | any | serviceHandler.ListRules |
POST | /api/v1/services/{id}/rules | engineer | serviceHandler.CreateRule |
DELETE | /api/v1/services/{id}/rules/{ruleId} | engineer | serviceHandler.DeleteRule |
PATCH | /api/v1/services/{id}/rules/{ruleId} | engineer | serviceHandler.UpdateRule |
GET | /api/v1/services/{id}/uptime | any | serviceHandler.GetUptimeHistory |
jira
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/jira/boards | engineer | copilotHandler.JiraBoards |
GET | /api/v1/jira/boards/{id}/epics | engineer | copilotHandler.JiraEpics |
GET | /api/v1/jira/boards/{id}/sprints | engineer | copilotHandler.JiraSprints |
GET | /api/v1/jira/boards/{id}/velocity | engineer | copilotHandler.JiraVelocity |
POST | /api/v1/jira/flow | engineer | copilotHandler.JiraFlow |
POST | /api/v1/jira/insights | engineer | copilotHandler.JiraInsights |
POST | /api/v1/jira/issues | engineer | copilotHandler.JiraCreateIssue |
GET | /api/v1/jira/issues/{key} | engineer | copilotHandler.JiraIssue |
GET | /api/v1/jira/issues/{key}/activity | engineer | copilotHandler.JiraIssueActivity |
GET | /api/v1/jira/issues/{key}/transitions | engineer | copilotHandler.JiraIssueTransitions |
POST | /api/v1/jira/issues/{key}/transitions | engineer | copilotHandler.JiraDoTransition |
GET | /api/v1/jira/projects | engineer | copilotHandler.JiraProjects |
GET | /api/v1/jira/projects/{key}/versions | engineer | copilotHandler.JiraVersions |
POST | /api/v1/jira/release-check | engineer | copilotHandler.JiraReleaseCheck |
GET | /api/v1/jira/search | engineer | copilotHandler.JiraSearch |
GET | /api/v1/jira/sprints/{id}/issues | engineer | copilotHandler.JiraSprintIssues |
schedules
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/schedules | any | onCallHandler.ListSchedules |
POST | /api/v1/schedules | engineer | onCallHandler.CreateSchedule |
DELETE | /api/v1/schedules/{id} | admin | onCallHandler.DeleteSchedule |
GET | /api/v1/schedules/{id} | any | onCallHandler.GetSchedule |
PUT | /api/v1/schedules/{id} | engineer | onCallHandler.UpdateSchedule |
POST | /api/v1/schedules/{id}/layers | engineer | onCallHandler.CreateLayer |
DELETE | /api/v1/schedules/{id}/layers/{layerId} | admin | onCallHandler.DeleteLayer |
PUT | /api/v1/schedules/{id}/layers/{layerId}/users | engineer | onCallHandler.SetLayerUsers |
GET | /api/v1/schedules/{id}/oncall | any | onCallHandler.GetOnCall |
GET | /api/v1/schedules/{id}/oncall.ics | any | onCallHandler.OnCallICS |
GET | /api/v1/schedules/{id}/oncall/upcoming | any | onCallHandler.UpcomingOnCall |
GET | /api/v1/schedules/{id}/overrides | any | onCallHandler.ListOverrides |
POST | /api/v1/schedules/{id}/overrides | engineer | onCallHandler.CreateOverride |
DELETE | /api/v1/schedules/{id}/overrides/{overrideId} | engineer | onCallHandler.DeleteOverride |
post-mortems
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/post-mortems | any | pmHandler.List |
POST | /api/v1/post-mortems | engineer | pmHandler.Create |
DELETE | /api/v1/post-mortems/{id} | admin | pmHandler.Delete |
GET | /api/v1/post-mortems/{id} | any | pmHandler.GetByID |
PATCH | /api/v1/post-mortems/{id} | engineer | pmHandler.Update |
GET | /api/v1/post-mortems/{id}/action-items | any | pmHandler.ListActionItems |
POST | /api/v1/post-mortems/{id}/action-items | engineer | pmHandler.CreateActionItem |
DELETE | /api/v1/post-mortems/{id}/action-items/{actionID} | engineer | pmHandler.DeleteActionItem |
PATCH | /api/v1/post-mortems/{id}/action-items/{actionID} | engineer | pmHandler.UpdateActionItem |
GET | /api/v1/post-mortems/{id}/audit | any | pmHandler.Audit |
GET | /api/v1/post-mortems/{id}/markdown | any | pmHandler.Markdown |
POST | /api/v1/post-mortems/{id}/publish | engineer | pmHandler.Publish |
GET | /api/v1/post-mortems/action-items | any | pmHandler.OpenActionItems |
GET | /api/v1/post-mortems/lessons | any | pmHandler.Lessons |
scim
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /scim/v2/Groups | any | enterpriseHandler.SCIMListGroups |
POST | /scim/v2/Groups | any | enterpriseHandler.SCIMCreateGroup |
DELETE | /scim/v2/Groups/{id} | any | enterpriseHandler.SCIMDeleteGroup |
GET | /scim/v2/Groups/{id} | any | enterpriseHandler.SCIMGetGroup |
PATCH | /scim/v2/Groups/{id} | any | enterpriseHandler.SCIMPatchGroup |
PUT | /scim/v2/Groups/{id} | any | enterpriseHandler.SCIMReplaceGroup |
GET | /scim/v2/ResourceTypes | any | enterpriseHandler.SCIMResourceTypes |
GET | /scim/v2/ServiceProviderConfig | any | enterpriseHandler.SCIMServiceProviderConfig |
GET | /scim/v2/Users | any | enterpriseHandler.SCIMListUsers |
POST | /scim/v2/Users | any | enterpriseHandler.SCIMCreateUser |
DELETE | /scim/v2/Users/{id} | any | enterpriseHandler.SCIMDeleteUser |
GET | /scim/v2/Users/{id} | any | enterpriseHandler.SCIMGetUser |
PATCH | /scim/v2/Users/{id} | any | enterpriseHandler.SCIMPatchUser |
PUT | /scim/v2/Users/{id} | any | enterpriseHandler.SCIMReplaceUser |
orgs
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/orgs | any | orgHandler.ListMyProjects |
POST | /api/v1/orgs | any | orgHandler.CreateProject |
GET | /api/v1/orgs/me | any | orgHandler.GetOrg |
PATCH | /api/v1/orgs/me | admin | orgHandler.UpdateOrg |
GET | /api/v1/orgs/me/api-keys | admin | orgHandler.ListAPIKeys |
POST | /api/v1/orgs/me/api-keys | admin | orgHandler.CreateAPIKey |
DELETE | /api/v1/orgs/me/api-keys/{id} | admin | orgHandler.DeleteAPIKey |
GET | /api/v1/orgs/me/invitations | admin | orgHandler.ListInvitations |
DELETE | /api/v1/orgs/me/invitations/{id} | admin | orgHandler.CancelInvitation |
GET | /api/v1/orgs/me/members | admin | orgHandler.ListMembers |
DELETE | /api/v1/orgs/me/members/{userId} | admin | orgHandler.RemoveMember |
PATCH | /api/v1/orgs/me/members/{userId}/role | admin | orgHandler.UpdateMemberRole |
POST | /api/v1/orgs/me/members/invite | admin | orgHandler.InviteUser |
elk
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/elk/alert-rules | any | datasourceAlertHandler.ListELKRules |
POST | /api/v1/elk/alert-rules | engineer | datasourceAlertHandler.CreateELKRule |
DELETE | /api/v1/elk/alert-rules/{id} | admin | datasourceAlertHandler.DeleteELKRule |
PUT | /api/v1/elk/alert-rules/{id} | engineer | datasourceAlertHandler.UpdateELKRule |
GET | /api/v1/elk/errors | any | elkHandler.GetErrors |
GET | /api/v1/elk/field-values | any | elkHandler.FieldValues |
GET | /api/v1/elk/fields | any | elkHandler.ListFields |
GET | /api/v1/elk/indices | any | elkHandler.ListIndices |
GET | /api/v1/elk/integration | any | elkHandler.GetIntegration |
GET | /api/v1/elk/overview | any | elkHandler.GetOverview |
GET | /api/v1/elk/search | any | elkHandler.Search |
POST | /api/v1/elk/test-connection | engineer | elkHandler.TestConnection |
mysql
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/mysql/{id}/collectors | any | mysqlNodeHandler.Collectors |
GET | /api/v1/mysql/{id}/lint | any | mysqlNodeHandler.Lint |
GET | /api/v1/mysql/{id}/live | engineer | mysqlNodeHandler.Live |
GET | /api/v1/mysql/{id}/queries | any | mysqlNodeHandler.Queries |
GET | /api/v1/mysql/{id}/replication | any | mysqlNodeHandler.Replication |
GET | /api/v1/mysql/{id}/schema | any | mysqlNodeHandler.Schema |
GET | /api/v1/mysql/{id}/timeline | any | mysqlNodeHandler.Timeline |
GET | /api/v1/mysql/consistency | any | mysqlNodeHandler.Consistency |
GET | /api/v1/mysql/overview | any | mysqlNodeHandler.Overview |
POST | /api/v1/mysql/test-connection | engineer | mysqlNodeHandler.TestConnection |
GET | /api/v1/mysql/topology | any | mysqlNodeHandler.Topology |
runbooks
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/runbooks | any | runbookHandler.List |
POST | /api/v1/runbooks | engineer | runbookHandler.Create |
DELETE | /api/v1/runbooks/{id} | admin | runbookHandler.Delete |
GET | /api/v1/runbooks/{id} | any | runbookHandler.GetByID |
PUT | /api/v1/runbooks/{id} | engineer | runbookHandler.Update |
GET | /api/v1/runbooks/{id}/runs | any | runbookHandler.ListRuns |
POST | /api/v1/runbooks/{id}/runs | engineer | runbookHandler.StartRun |
GET | /api/v1/runbooks/{id}/runs/{runId} | any | runbookHandler.GetRun |
POST | /api/v1/runbooks/{id}/runs/{runId}/complete | engineer | runbookHandler.CompleteRun |
PATCH | /api/v1/runbooks/{id}/runs/{runId}/steps/{stepId} | engineer | runbookHandler.UpdateStepState |
cost
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/cost/cloud | engineer | costHandler.CloudSummary |
GET | /api/v1/cost/connectors | engineer | costHandler.ListConnectors |
POST | /api/v1/cost/connectors | admin | costHandler.CreateConnector |
DELETE | /api/v1/cost/connectors/{id} | admin | costHandler.DeleteConnector |
PUT | /api/v1/cost/connectors/{id} | admin | costHandler.UpdateConnector |
POST | /api/v1/cost/connectors/{id}/sync | engineer | costHandler.SyncConnector |
POST | /api/v1/cost/connectors/sync | engineer | costHandler.SyncAllConnectors |
GET | /api/v1/cost/providers | engineer | costHandler.ListProviders |
POST | /api/v1/cost/records | engineer | costHandler.Ingest |
GET | /api/v1/cost/summary | any | costHandler.Summary |
alert-rules
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/alert-rules | any | alertHandler.ListRules |
POST | /api/v1/alert-rules | engineer | alertHandler.CreateRule |
DELETE | /api/v1/alert-rules/{id} | admin | alertHandler.DeleteRule |
GET | /api/v1/alert-rules/{id} | any | alertHandler.GetRule |
PATCH | /api/v1/alert-rules/{id} | engineer | alertHandler.UpdateRule |
POST | /api/v1/alert-rules/{id}/clone | engineer | alertHandler.CloneRule |
GET | /api/v1/alert-rules/{id}/metrics | any | alertHandler.RuleMetrics |
POST | /api/v1/alert-rules/{id}/silence | engineer | alertHandler.SilenceRule |
POST | /api/v1/alert-rules/{id}/test-fire | engineer | alertHandler.TestFireRule |
dashboards
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/dashboards | any | customDashboardHandler.List |
POST | /api/v1/dashboards | engineer | customDashboardHandler.Create |
DELETE | /api/v1/dashboards/{id} | admin | customDashboardHandler.Delete |
GET | /api/v1/dashboards/{id} | any | customDashboardHandler.GetByID |
PATCH | /api/v1/dashboards/{id} | engineer | customDashboardHandler.Update |
PUT | /api/v1/dashboards/{id}/layout | engineer | customDashboardHandler.UpdateLayout |
POST | /api/v1/dashboards/{id}/widgets | engineer | customDashboardHandler.AddWidget |
DELETE | /api/v1/dashboards/{id}/widgets/{wid} | engineer | customDashboardHandler.DeleteWidget |
PATCH | /api/v1/dashboards/{id}/widgets/{wid} | engineer | customDashboardHandler.UpdateWidget |
GET | /api/v1/dashboards/widgets/{widgetID}/data | any | customDashboardHandler.WidgetData |
teams
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/teams | any | teamHandler.List |
POST | /api/v1/teams | engineer | teamHandler.Create |
DELETE | /api/v1/teams/{id} | admin | teamHandler.Delete |
GET | /api/v1/teams/{id} | any | teamHandler.GetByID |
PATCH | /api/v1/teams/{id} | admin | teamHandler.Update |
GET | /api/v1/teams/{id}/members | any | teamHandler.ListMembers |
POST | /api/v1/teams/{id}/members | admin | teamHandler.AddMember |
DELETE | /api/v1/teams/{id}/members/{userId} | admin | teamHandler.RemoveMember |
PATCH | /api/v1/teams/{id}/members/{userId}/role | admin | teamHandler.UpdateMemberRole |
deploy-safety
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/deploy-safety/audit | any | deploySafetyHandler.ListAudit |
GET | /api/v1/deploy-safety/environments | any | deploySafetyHandler.Environments |
GET | /api/v1/deploy-safety/freezes | any | deploySafetyHandler.ListFreezes |
POST | /api/v1/deploy-safety/freezes | engineer | deploySafetyHandler.CreateFreeze |
DELETE | /api/v1/deploy-safety/freezes/{id} | engineer | deploySafetyHandler.DeleteFreeze |
GET | /api/v1/deploy-safety/gate | any | deploySafetyHandler.Gate |
GET | /api/v1/deploy-safety/smoke-tests | any | deploySafetyHandler.ListSmokeConfigs |
POST | /api/v1/deploy-safety/smoke-tests | engineer | deploySafetyHandler.CreateSmokeConfig |
DELETE | /api/v1/deploy-safety/smoke-tests/{id} | engineer | deploySafetyHandler.DeleteSmokeConfig |
PATCH | /api/v1/deploy-safety/smoke-tests/{id} | engineer | deploySafetyHandler.UpdateSmokeConfig |
domain-health
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/domain-health | any | domainHealthHandler.Board |
GET | /api/v1/domain-health/catalogue | any | domainHealthHandler.Catalogue |
GET | /api/v1/domain-health/domains | any | domainHealthHandler.ListDomains |
POST | /api/v1/domain-health/domains | engineer | domainHealthHandler.SaveDomain |
DELETE | /api/v1/domain-health/domains/{domain} | engineer | domainHealthHandler.DeleteDomain |
POST | /api/v1/domain-health/ingest | any | domainHealthHandler.Ingest |
GET | /api/v1/domain-health/views | any | domainHealthHandler.ListViews |
POST | /api/v1/domain-health/views | any | domainHealthHandler.SaveView |
DELETE | /api/v1/domain-health/views/{id} | any | domainHealthHandler.DeleteView |
synthetic
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/synthetic | any | syntheticHandler.List |
POST | /api/v1/synthetic | engineer | syntheticHandler.Create |
DELETE | /api/v1/synthetic/{id} | admin | syntheticHandler.Delete |
GET | /api/v1/synthetic/{id} | any | syntheticHandler.GetByID |
PATCH | /api/v1/synthetic/{id} | engineer | syntheticHandler.Update |
POST | /api/v1/synthetic/{id}/run | engineer | syntheticHandler.RunNow |
GET | /api/v1/synthetic/{id}/runs | any | syntheticHandler.ListRuns |
GET | /api/v1/synthetic/{id}/runs/{runId} | any | syntheticHandler.GetRun |
chaos
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/chaos | any | chaosHandler.List |
POST | /api/v1/chaos | engineer | chaosHandler.Create |
DELETE | /api/v1/chaos/{id} | admin | chaosHandler.Delete |
GET | /api/v1/chaos/{id} | any | chaosHandler.GetByID |
PATCH | /api/v1/chaos/{id} | engineer | chaosHandler.Update |
POST | /api/v1/chaos/{id}/complete | engineer | chaosHandler.CompleteRun |
POST | /api/v1/chaos/{id}/run | engineer | chaosHandler.StartRun |
GET | /api/v1/chaos/{id}/runs | any | chaosHandler.ListRuns |
changes
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/changes | any | changeLedgerHandler.Feed |
GET | /api/v1/changes/collectors | any | changeLedgerHandler.CollectorHealth |
GET | /api/v1/changes/config-at | any | changeLedgerHandler.ConfigAt |
GET | /api/v1/changes/config-diff | any | changeLedgerHandler.ConfigDiff |
GET | /api/v1/changes/config-environments | any | changeLedgerHandler.ConfigEnvironments |
GET | /api/v1/changes/config-timeline | any | changeLedgerHandler.SnapshotTimeline |
GET | /api/v1/changes/drift | any | changeLedgerHandler.DriftList |
POST | /api/v1/changes/drift/ack | engineer | changeLedgerHandler.DriftAck |
GET | /api/v1/changes/what-changed | any | changeLedgerHandler.WhatChanged |
webhooks
| Method | Path | Role | Handler |
|---|---|---|---|
POST | /api/v1/webhooks/github/{orgID} | any | copilotHandler.GitHubWebhook |
POST | /api/v1/webhooks/inbound/{integrationID} | any | integrationHandler.ReceiveWebhook |
POST | /api/v1/webhooks/metrics/{key} | any | metricWebhookHandler.Push |
POST | /api/v1/webhooks/slack/interact | any | callbackHandler.HandleSlackInteraction |
POST | /api/v1/webhooks/telegram | any | callbackHandler.HandleTelegramWebhook |
POST | /api/v1/webhooks/twilio/voice | any | callbackHandler.HandleTwilioVoiceStatus |
channels
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/channels | any | channelHandler.List |
POST | /api/v1/channels | engineer | channelHandler.Create |
DELETE | /api/v1/channels/{id} | admin | channelHandler.Delete |
PATCH | /api/v1/channels/{id} | engineer | channelHandler.Update |
POST | /api/v1/channels/{id}/test | engineer | channelHandler.Test |
GET | /api/v1/channels/escalation-settings | any | channelHandler.GetEscalationSettings |
PUT | /api/v1/channels/escalation-settings | engineer | channelHandler.UpdateEscalationSettings |
routing-rules
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/routing-rules | any | escalationHandler.ListRoutingRules |
POST | /api/v1/routing-rules | admin | escalationHandler.CreateRoutingRule |
DELETE | /api/v1/routing-rules/{id} | admin | escalationHandler.DeleteRoutingRule |
PUT | /api/v1/routing-rules/{id} | admin | escalationHandler.UpdateRoutingRule |
PATCH | /api/v1/routing-rules/{id}/toggle | admin | escalationHandler.ToggleRoutingRule |
POST | /api/v1/routing-rules/reorder | admin | escalationHandler.ReorderRoutingRules |
POST | /api/v1/routing-rules/simulate | any | escalationHandler.SimulateRouting |
environments
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/environments | any | orgEnvHandler.List |
POST | /api/v1/environments | admin | orgEnvHandler.Upsert |
DELETE | /api/v1/environments/{id} | admin | orgEnvHandler.Delete |
GET | /api/v1/environments/jenkins-jobs | any | orgEnvHandler.JenkinsJobs |
PUT | /api/v1/environments/jenkins-jobs | admin | orgEnvHandler.AssignJenkinsJobs |
GET | /api/v1/environments/reporting | any | orgEnvHandler.GetReportingPrefs |
PUT | /api/v1/environments/reporting | admin | orgEnvHandler.SetReportingPrefs |
POST | /api/v1/environments/resolve | any | orgEnvHandler.Resolve |
workflows
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/workflows | any | workflowHandler.List |
POST | /api/v1/workflows | engineer | workflowHandler.Create |
DELETE | /api/v1/workflows/{id} | admin | workflowHandler.Delete |
GET | /api/v1/workflows/{id} | any | workflowHandler.GetByID |
PATCH | /api/v1/workflows/{id} | engineer | workflowHandler.Update |
GET | /api/v1/workflows/{id}/runs | any | workflowHandler.ListRuns |
POST | /api/v1/workflows/{id}/trigger | engineer | workflowHandler.TriggerManual |
health
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /health | any | healthHandler.LivenessHandler |
GET | /health/dependencies | any | healthHandler.DependencyCheckHandler |
GET | /health/detailed | any | healthHandler.DetailedHealthHandler |
GET | /health/live | any | healthHandler.LivenessHandler |
GET | /health/ready | any | healthHandler.ReadinessHandler |
GET | /health/system | any | healthHandler.SystemInfoHandler |
alerts
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/alerts | any | alertHandler.List |
GET | /api/v1/alerts/{id} | any | alertHandler.GetByID |
PATCH | /api/v1/alerts/{id} | engineer | alertHandler.UpdateStatus |
POST | /api/v1/alerts/{id}/acknowledge | engineer | callbackHandler.HandleManualAcknowledge |
GET | /api/v1/alerts/{id}/delivery | any | notificationsHandler.ListByAlert |
GET | /api/v1/alerts/counts | any | alertHandler.Counts |
alert-templates
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/alert-templates | any | alertTemplateHandler.List |
POST | /api/v1/alert-templates | engineer | alertTemplateHandler.Create |
DELETE | /api/v1/alert-templates/{id} | admin | alertTemplateHandler.Delete |
GET | /api/v1/alert-templates/{id} | any | alertTemplateHandler.GetByID |
PATCH | /api/v1/alert-templates/{id} | engineer | alertTemplateHandler.Update |
POST | /api/v1/alert-templates/{id}/preview | any | alertTemplateHandler.Preview |
POST | /api/v1/alert-templates/preview | engineer | alertTemplateHandler.PreviewRaw |
escalation-policies
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/escalation-policies | any | escalationHandler.ListPolicies |
POST | /api/v1/escalation-policies | admin | escalationHandler.CreatePolicy |
DELETE | /api/v1/escalation-policies/{id} | admin | escalationHandler.DeletePolicy |
GET | /api/v1/escalation-policies/{id} | any | escalationHandler.GetPolicy |
PUT | /api/v1/escalation-policies/{id} | admin | escalationHandler.UpdatePolicy |
PATCH | /api/v1/escalation-policies/{id}/toggle | admin | escalationHandler.TogglePolicy |
network
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/network/monitors | any | networkHandler.ListMonitors |
POST | /api/v1/network/monitors | engineer | networkHandler.CreateMonitor |
DELETE | /api/v1/network/monitors/{id} | admin | networkHandler.DeleteMonitor |
PUT | /api/v1/network/monitors/{id} | engineer | networkHandler.UpdateMonitor |
GET | /api/v1/network/monitors/{id}/probes | any | networkHandler.ListProbes |
POST | /api/v1/network/probes | engineer | networkHandler.IngestProbe |
ingest
| Method | Path | Role | Handler |
|---|---|---|---|
GET, OPTIONS | /ingest/ab-config | any | abConfigHandler.Serve |
POST, OPTIONS | /ingest/ab-uniques | any | abConfigHandler.Uniques |
POST, OPTIONS | /ingest/sourcemaps | any | webIngestHandler.UploadSourceMap |
POST, OPTIONS | /ingest/spans | any | webIngestHandler.IngestSpans |
POST, OPTIONS | /ingest/web-errors | any | webIngestHandler.Ingest |
POST, OPTIONS | /ingest/web-sessions | any | webIngestHandler.IngestSession |
public
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/public/postmortem/{slug} | any | pmHandler.GetPublic |
GET | /api/v1/public/saas-report/{token} | any | saasReportHandler.PublicView |
GET | /api/v1/public/status/{slug} | any | statusHandler.GetBySlug |
POST | /api/v1/public/status/{slug}/subscribe | any | statusHandler.Subscribe |
GET | /api/v1/public/status/unsubscribe | any | statusHandler.Unsubscribe |
agent
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/agent/connect | any | agentHandler.ConnectWS |
POST | /api/v1/agent/device/poll | any | agentHandler.DevicePoll |
POST | /api/v1/agent/device/start | any | agentHandler.DeviceStart |
GET | /api/v1/agent/shell | any | agentHandler.ShellWS |
GET | /api/v1/agent/shell/stream | any | agentHandler.ShellStream |
GET | /api/v1/agent/ws-check | any | agentHandler.WSCheck |
maintenance
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/maintenance | any | maintenanceHandler.List |
POST | /api/v1/maintenance | engineer | maintenanceHandler.Create |
DELETE | /api/v1/maintenance/{id} | admin | maintenanceHandler.Delete |
GET | /api/v1/maintenance/{id} | any | maintenanceHandler.GetByID |
PATCH | /api/v1/maintenance/{id} | engineer | maintenanceHandler.Update |
analytics
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/analytics | any | analyticsHandler.Report |
GET | /api/v1/analytics/escalation | any | escAnalyticsHandler.GetReport |
GET | /api/v1/analytics/escalation/slo | any | escAnalyticsHandler.GetSLO |
PUT | /api/v1/analytics/escalation/slo | engineer | escAnalyticsHandler.UpdateSLO |
GET | /api/v1/analytics/export | any | analyticsHandler.Export |
rules
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/rules | any | settingsHandler.Rules |
PUT | /api/v1/rules/{id} | engineer | settingsHandler.SetRule |
DELETE | /api/v1/rules/{id}/acknowledge | engineer | settingsHandler.Unacknowledge |
POST | /api/v1/rules/{id}/acknowledge | engineer | settingsHandler.Acknowledge |
PUT | /api/v1/rules/{id}/runbook | engineer | settingsHandler.SetRunbook |
GET | /api/v1/rules/suppressed | any | settingsHandler.Suppressed |
apm
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/apm/overview | any | apmHandler.Overview |
GET | /api/v1/apm/services | any | apmHandler.ServiceStats |
POST | /api/v1/apm/spans | engineer | apmHandler.Ingest |
GET | /api/v1/apm/traces | any | apmHandler.ListTraces |
GET | /api/v1/apm/traces/{traceId} | any | apmHandler.GetTrace |
ab-configs
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/ab-configs | any | abConfigHandler.Projects |
GET | /api/v1/ab-configs/{project} | any | abConfigHandler.Get |
PUT | /api/v1/ab-configs/{project} | engineer | abConfigHandler.Save |
POST | /api/v1/ab-configs/{project}/simulate | any | abConfigHandler.Simulate |
GET | /api/v1/ab-configs/{project}/stats | any | abConfigHandler.Stats |
GET | /api/v1/ab-configs/{project}/versions | any | abConfigHandler.Versions |
slos
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/slos | any | sloHandler.List |
POST | /api/v1/slos | engineer | sloHandler.Create |
DELETE | /api/v1/slos/{id} | admin | sloHandler.Delete |
PATCH | /api/v1/slos/{id} | engineer | sloHandler.Update |
GET | /api/v1/slos/{id}/status | any | sloHandler.GetStatus |
users
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/users | admin | authHandler.ListUsers |
POST | /api/v1/users | admin | authHandler.Register |
DELETE | /api/v1/users/{id} | admin | authHandler.DeactivateUser |
PATCH | /api/v1/users/{id} | admin | authHandler.UpdateUser |
PATCH | /api/v1/users/{id}/role | admin | authHandler.UpdateUserRole |
notifications
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/notifications/delivery | engineer | notificationsHandler.ListByOrg |
POST | /api/v1/notifications/delivery/{id}/requeue | engineer | notificationsHandler.Requeue |
GET | /api/v1/notifications/delivery/dlq | engineer | notificationsHandler.ListDLQ |
POST | /api/v1/notifications/delivery/dlq/requeue | admin | notificationsHandler.BulkRequeue |
GET | /api/v1/notifications/retry-policy | any | notificationsHandler.RetryPolicy |
integrations
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/integrations | any | integrationHandler.List |
POST | /api/v1/integrations | engineer | integrationHandler.Create |
DELETE | /api/v1/integrations/{id} | admin | integrationHandler.Delete |
PATCH | /api/v1/integrations/{id} | engineer | integrationHandler.Update |
infisical
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/infisical/drift | any | infisicalHandler.Drift |
GET | /api/v1/infisical/rotation | any | infisicalHandler.Rotation |
GET | /api/v1/infisical/secrets | any | infisicalHandler.Secrets |
POST | /api/v1/infisical/snapshot | engineer | infisicalHandler.Snapshot |
GET | /api/v1/infisical/status | any | infisicalHandler.Status |
infra
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/infra/nodes | any | infraHandler.ListNodes |
GET | /api/v1/infra/nodes/{instance}/history | any | infraHandler.GetNodeHistory |
GET | /api/v1/infra/nodes/{instance}/series | any | infraHandler.GetNodeSeries |
POST | /api/v1/infra/test-connection | engineer | infraHandler.TestConnection |
compliance
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/compliance/audit/export | admin | complianceHandler.AuditExport |
GET | /api/v1/compliance/audit/preview | admin | complianceHandler.AuditPreview |
GET | /api/v1/compliance/export-log | admin | complianceHandler.ExportLog |
GET | /api/v1/compliance/users/{userId}/data-export | admin | complianceHandler.UserDataExport |
POST | /api/v1/compliance/users/{userId}/erase | owner | complianceHandler.EraseUser |
sdk
| Method | Path | Role | Handler |
|---|---|---|---|
POST, OPTIONS | /sdk/feature-flags/events | any | flagSDKHandler.Events |
GET, OPTIONS | /sdk/feature-flags/resolve | any | flagSDKHandler.Resolve |
GET, OPTIONS | /sdk/feature-flags/stream | any | flagSDKHandler.Stream |
GET, OPTIONS | /sdk/feature-flags/track | any | flagSDKHandler.Track |
settings
| Method | Path | Role | Handler |
|---|---|---|---|
DELETE | /api/v1/settings/{key} | engineer | settingsHandler.ClearOverride |
PUT | /api/v1/settings/{key} | engineer | settingsHandler.SetOverride |
GET | /api/v1/settings/catalogue | any | settingsHandler.Catalogue |
GET | /api/v1/settings/overrides | any | settingsHandler.Overrides |
jobs
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/jobs | any | settingsHandler.Jobs |
POST | /api/v1/jobs/{id}/run | engineer | settingsHandler.RunJob |
GET | /api/v1/jobs/{id}/runs | any | settingsHandler.JobRuns |
retention
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/retention | any | dataRetentionHandler.Get |
PUT | /api/v1/retention | admin | dataRetentionHandler.Update |
POST | /api/v1/retention/enforce | admin | dataRetentionHandler.Enforce |
system-alert-config
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/system-alert-config | any | systemAlertConfigHandler.Get |
PUT | /api/v1/system-alert-config | admin | systemAlertConfigHandler.Upsert |
POST | /api/v1/system-alert-config/test | engineer | systemAlertConfigHandler.Test |
reports
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/reports/schedule | any | reportHandler.GetSchedule |
PUT | /api/v1/reports/schedule | admin | reportHandler.UpsertSchedule |
POST | /api/v1/reports/send | engineer | reportHandler.SendNow |
deploy
| Method | Path | Role | Handler |
|---|---|---|---|
POST | /api/v1/deploy/{deploy_key} | any | deployWebhookHandler.Receive |
GET | /api/v1/deploy/{deploy_key}/gate | any | deployWebhookHandler.Gate |
POST | /api/v1/deploy/{deploy_key}/target | any | deployFleetHandler.RecordRun |
dependencies
| Method | Path | Role | Handler |
|---|---|---|---|
POST | /api/v1/dependencies | engineer | dependencyHandler.Create |
DELETE | /api/v1/dependencies/{id} | engineer | dependencyHandler.Delete |
GET | /api/v1/dependencies/{id}/impact | any | dependencyHandler.Impact |
baselines
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/baselines | any | settingsHandler.Baselines |
POST | /api/v1/baselines | engineer | settingsHandler.SaveBaseline |
me
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/me/tokens | any | enterpriseHandler.MyTokens |
POST | /api/v1/me/tokens | any | enterpriseHandler.CreateToken |
DELETE | /api/v1/me/tokens/{id} | any | enterpriseHandler.RevokeToken |
status-page
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/status-page/config | any | statusHandler.GetConfig |
PUT | /api/v1/status-page/config | admin | statusHandler.UpsertConfig |
sso
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/sso/config | admin | ssoHandler.GetConfig |
PUT | /api/v1/sso/config | admin | ssoHandler.UpsertConfig |
POST | /api/v1/sso/config/test | admin | ssoHandler.TestConnection |
superset-proxy
| Method | Path | Role | Handler |
|---|---|---|---|
GET, POST | /superset-proxy/{connectionId}/{path:.*} | any | dwhHandler.SupersetEmbedProxy |
heartbeat
| Method | Path | Role | Handler |
|---|---|---|---|
POST | /api/v1/heartbeat/{key} | any | heartbeatHandler.Receive |
events
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/events | any | sseHandler.Connect |
dashboard
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/dashboard/stats | any | dashboardHandler.Stats |
config
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/config/export | admin | configHandler.Export |
POST | /api/v1/config/import | admin | configHandler.Import |
audit-logs
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/audit-logs | any | auditHandler.List |
v1
| Method | Path | Role | Handler |
|---|---|---|---|
POST | /v1/traces | any | otlpHandler.Traces |
ab-config
| Method | Path | Role | Handler |
|---|---|---|---|
GET, OPTIONS | /ab-config | any | abConfigHandler.Serve |
escalations
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/escalations | any | callbackHandler.ListEscalations |
search
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/search | any | dashboardHandler.Search |
dependency-graph
| Method | Path | Role | Handler |
|---|---|---|---|
GET | /api/v1/dependency-graph | any | dependencyHandler.GetGraph |
timeseries
| Method | Path | Role | Handler |
|---|---|---|---|
POST | /api/v1/timeseries/query | any | timeSeriesHandler.Query |
Where this behaviour lives: backend/internal/handler/router.go. If the code and this page disagree, the code is right — please fix the page.
Part of Reference — The exact numbers, names and limits, generated from the code.