Skip to main content

API Reference

This reference is generated from gateway route source files and project API docs.

Indexed Endpoints

MethodPathSource
DELETE$\{path\}/:idapps/gateway/src/routes/resources.ts:392
GET$\{path\}/:idapps/gateway/src/routes/resources.ts:168
PATCH$\{path\}/:idapps/gateway/src/routes/resources.ts:318
PUT$\{path\}/:idapps/gateway/src/routes/resources.ts:253
GET/.well-known/engine-statusapps/gateway/src/routes/health.ts:35
GET/api/v1/agent-runtime/agentsapps/gateway/src/routes/agent-runtime.ts:270
GET/api/v1/agent-runtime/failuresapps/gateway/src/routes/agent-runtime.ts:221
GET/api/v1/agent-runtime/healthapps/gateway/src/routes/agent-runtime.ts:99
POST/api/v1/agent-runtime/job-failures/:id/retryapps/gateway/src/routes/agent-runtime.ts:392
POST/api/v1/agent-runtime/outbox-failures/:id/retryapps/gateway/src/routes/agent-runtime.ts:365
GET/api/v1/agent-runtime/queuesapps/gateway/src/routes/agent-runtime.ts:181
POST/api/v1/agent-runtime/smokeapps/gateway/src/routes/agent-runtime.ts:419
GET/api/v1/audit-credentialsapps/gateway/src/routes/execute.ts:75
GET/api/v1/dashboard/summaryapps/gateway/src/routes/dashboard.ts:83
GET/api/v1/edge-agent/enrollmentapps/gateway/src/routes/edge-agent.ts:68
POST/api/v1/edge-agent/enrollment/rotateapps/gateway/src/routes/edge-agent.ts:96
GET/api/v1/edge-agent/ingest-statusapps/gateway/src/routes/edge-agent.ts:152
GET/api/v1/edge-agent/policyapps/gateway/src/routes/edge-agent.ts:25
POST/api/v1/events/ingestapps/gateway/src/routes/events.ts:57
GET/api/v1/events/ingest-batchesapps/gateway/src/routes/events.ts:34
GET/api/v1/events/outboxapps/gateway/src/routes/events.ts:11
POST/api/v1/execute/:agent.:reasonerapps/gateway/src/routes/execute.ts:98
POST/api/v1/exportsapps/gateway/src/routes/import-export.ts:89
GET/api/v1/healthapps/gateway/src/routes/health.ts:31
POST/api/v1/importsapps/gateway/src/routes/import-export.ts:39
POST/api/v1/integrations/accounting/syncapps/gateway/src/routes/adapters.ts:21
POST/api/v1/integrations/github/webhookapps/gateway/src/routes/integrations.ts:31
POST/api/v1/integrations/notifications/testapps/gateway/src/routes/adapters.ts:74
GET/api/v1/jobsapps/gateway/src/routes/import-export.ts:8
GET/api/v1/openapiapps/gateway/src/routes/openapi.ts:8
POST/api/v1/ops/alerts/:id/link-ticketapps/gateway/src/routes/ops-actions.ts:49
GET/api/v1/ops/summaryapps/gateway/src/routes/dashboard.ts:276
POST/api/v1/ops/tickets/:id/escalateapps/gateway/src/routes/ops-actions.ts:227
POST/api/v1/ops/tickets/:id/link-assetapps/gateway/src/routes/ops-actions.ts:130
POST/api/v1/ops/tickets/:id/link-runbookapps/gateway/src/routes/ops-actions.ts:175
POST/api/v1/ops/tickets/:id/resolveapps/gateway/src/routes/ops-actions.ts:290
GET/api/v1/platform/secretsapps/gateway/src/routes/settings.ts:99
POST/api/v1/platform/secrets/:keyapps/gateway/src/routes/settings.ts:114
GET/api/v1/platform/settingsapps/gateway/src/routes/settings.ts:31
PUT/api/v1/platform/settingsapps/gateway/src/routes/settings.ts:53
GET/api/v1/portal/clientsapps/gateway/src/routes/portal-actions.ts:356
GET/api/v1/portal/invitesapps/gateway/src/routes/portal-actions.ts:262
POST/api/v1/portal/invitesapps/gateway/src/routes/portal-actions.ts:158
POST/api/v1/portal/invites/:id/revokeapps/gateway/src/routes/portal-actions.ts:285
GET/api/v1/portal/invoicesapps/gateway/src/routes/portal-actions.ts:433
POST/api/v1/portal/invoices/:id/acknowledgeapps/gateway/src/routes/portal-actions.ts:684
POST/api/v1/portal/invoices/:id/payment-intentapps/gateway/src/routes/portal-actions.ts:742
GET/api/v1/portal/knowledge-baseapps/gateway/src/routes/portal-actions.ts:323
GET/api/v1/portal/paymentsapps/gateway/src/routes/portal-actions.ts:459
GET/api/v1/portal/quotesapps/gateway/src/routes/portal-actions.ts:408
POST/api/v1/portal/quotes/:id/decisionapps/gateway/src/routes/portal-actions.ts:616
POST/api/v1/portal/session/exchangeapps/gateway/src/routes/portal-actions.ts:113
POST/api/v1/portal/session/terminateapps/gateway/src/routes/portal-actions.ts:150
GET/api/v1/portal/summaryapps/gateway/src/routes/dashboard.ts:177
GET/api/v1/portal/ticketsapps/gateway/src/routes/portal-actions.ts:382
POST/api/v1/portal/ticketsapps/gateway/src/routes/portal-actions.ts:490
POST/api/v1/portal/tickets/:id/updateapps/gateway/src/routes/portal-actions.ts:552
POST/api/v1/webhooks/workflow-completedapps/gateway/src/routes/execute.ts:329
GET/api/v1/workflow-executionsapps/gateway/src/routes/execute.ts:24
GET/api/v1/workflow-executions/:idapps/gateway/src/routes/execute.ts:47
POST/api/v1/workflow-executions/:id/cancelapps/gateway/src/routes/execute.ts:275
POST/api/v1/workflow-executions/:id/retryapps/gateway/src/routes/execute.ts:190
GET/api/v1/workspace/secretsapps/gateway/src/routes/settings.ts:244
POST/api/v1/workspace/secrets/:keyapps/gateway/src/routes/settings.ts:267
GET/api/v1/workspace/settingsapps/gateway/src/routes/settings.ts:169
PUT/api/v1/workspace/settingsapps/gateway/src/routes/settings.ts:198
GET/healthapps/gateway/src/routes/health.ts:27

Required Headers (from repository docs and contracts)

  • x-workspace-id: required for tenant-scoped routes.
  • Idempotency-Key: required for mutating routes.
  • Authorization: Bearer <jwt>: required when AUTH_MODE=jwt.
  • x-correlation-id: optional request tracing header.
  • Signature headers required for enabled webhook integrations.

OpenAPI Source