HTTP routes¶
Ids and filters as query parameters. A gateway web session authenticates with its cookie (and X-CSRF-Token for a
write, from GET /data/artekis/web/status); a platform API token with Read or Write authenticates everything else.
| Route | Access |
|---|---|
GET /data/artekis/status |
open; {module, version, healthy, scheduling} only |
GET /data/artekis/web/status |
Read; everything the Status page shows |
GET /data/artekis/ddl |
the DDL for the configured connection's vendor |
GET /data/artekis/run?id=, GET /data/artekis/findings?…&page=&size=, GET /data/artekis/finding?id= |
Read |
POST /data/artekis/trigger (body: the event) |
Write |
POST /data/artekis/feedback (body {findingId, verdict, note, spanRef} or {runId, verdict, note}) |
Write |
POST /data/artekis/ask (body {question, collection, assetId, conversationId, findingId}) |
Write; read the answer at GET /data/artekis/run?id= |
POST /data/artekis/provider/probe[?call=true] |
Write; the provider probe |
GET …/web/config/providers, GET …/web/config/provider?name=, GET …/web/config/policy, GET …/web/config/settings; PUT and DELETE likewise; GET …/web/config/choices |
Read / Write; whole documents with a revision (section 6) |
POST …/web/context-model/bootstrap (body {collection, roots, sources, suggest}) |
Write |
GET …/web/documents?collection=, POST …/web/documents?collection=&filename=, DELETE …/web/documents?id= |
Read / Write (section 7.4) |
GET …/web/cost?range=day\|week\|month&from=&to=, GET …/web/egress?…, GET …/web/egress/item?run=&seq= |
Read |
POST …/web/test-run?playbook=&collection=&call=false\|true, GET …/web/test-run?id= |
Write / Read |
GET …/web/tools, POST …/web/tools/call (body {tool, args, collection}), GET …/web/tools/calls?limit= |
Read / Write (section 11.3) |
GET …/web/detectors?collection=&asset=&includeRejected=, GET …/web/detector/export?collection=&id= (served as a file download) |
Read (section 8.5) |
GET …/web/anomaly/setup-draft?collection=&assetIds=a,b&project=&prefill=, POST …/web/anomaly/setup (body {project, collection, setup, revision, runNow}) |
Read / Write (section 8.5) |
GET …/web/interview/pending?collection=, POST …/web/interview/start (body {collection, assetId, audience}), POST …/web/interview/answer (body {sessionId, answers}), POST …/web/interview/confirm (body {sessionId, drafts}) |
Read / Write (section 7.10) |
POST …/web/views/install?project=, POST …/web/ownership/take |
a gateway session with Write |
A request a mutating route refuses for its shape (400) leaves an Artekis.Audit line naming the actor, route and
status, never the body.