AdversaryGraph API reference

July 26, 2026 · View on GitHub

  • Version: 6.5.0
  • Modules: 28 Operations: 323

Interactive contracts are available from a running deployment at /docs, /redoc, and /openapi.json. All platform operations use /api; protected operations accept the native session cookie or Authorization: Bearer <token>. External-provider operations can also return a documented 4xx/5xx dependency status when the corresponding credential, policy permission, or service is unavailable.

Contract completeness is checked with ./scripts/check-api-contracts.py. Against a running deployment, ./scripts/test-api-live.py --base-url http://127.0.0.1:3000 probes every read-only operation and fails on an unhandled response. Mutating operations are exercised by the backend integration suite rather than by the live smoke command.

ATT&CK

7 operations.

MethodPathOperationSuccess
GET/api/attack/stix/objects/{stix_id}Get Stix Object200
GET/api/attack/stix/objects/{stix_id}/graphGet Stix Object Graph200
GET/api/attack/stix/relationshipsList Stix Relationships200
GET/api/attack/tacticsList Tactics200
GET/api/attack/techniquesList Techniques200
GET/api/attack/techniques/{attack_id}Get Technique200
GET/api/attack/versionsList Versions200

ATT&CK Group Profiles

7 operations.

MethodPathOperationSuccess
GET/api/apt/campaignsList Campaigns200
POST/api/apt/campaigns/compareCompare Campaigns200
GET/api/apt/campaigns/{attack_id}Get Campaign200
POST/api/apt/compareCompare Ttps200
GET/api/apt/groupsList Groups200
GET/api/apt/groups/{attack_id}Get Group200
POST/api/apt/overlap/explainExplain Ttp Overlap200

Analysis

15 operations.

MethodPathOperationSuccess
POST/api/analyzeAnalyze200
POST/api/analyze/chatChat200
POST/api/analyze/log-pcapAnalyze Log Pcap200
GET/api/analyze/sessionsList Sessions200
GET/api/analyze/sessions/collectionReport Collection200
POST/api/analyze/sessions/researchStore Research200
POST/api/analyze/sessions/research-urlIngest Research Url200
DELETE/api/analyze/sessions/{session_id}Delete Session204
POST/api/analyze/sessions/{session_id}/compareCompare Session200
GET/api/analyze/sessions/{session_id}/linked-reportLinked Report200
PATCH/api/analyze/sessions/{session_id}/linked-reportEdit Linked Report200
POST/api/analyze/sessions/{session_id}/reparseReparse Linked Report200
PATCH/api/analyze/sessions/{session_id}/techniques/{attack_id}/reviewUpdate Technique Review200
POST/api/analyze/streamAnalyze Stream200
GET/api/analyze/{session_id}Get Result200

Asset Attack Surface

8 operations.

MethodPathOperationSuccess
POST/api/asset-surface/analyzeAnalyze Asset Surface200
GET/api/asset-surface/assetsList Registered Assets200
GET/api/asset-surface/casesList Asset Surface Cases200
DELETE/api/asset-surface/cases/{case_id}Delete Asset Surface Case204
GET/api/asset-surface/cases/{case_id}Get Asset Surface Case200
GET/api/asset-surface/csv-schemaAsset Surface Csv Schema200
GET/api/asset-surface/intel-matchesList Registered Asset Matches200
POST/api/asset-surface/retrohuntRun Asset Retrohunt200

Attack Simulation

14 operations.

MethodPathOperationSuccess
GET/api/simulation/ai-assistant/scenariosAi Assistant Scenarios200
POST/api/simulation/ai-assistant/telemetryAi Assistant Telemetry200
GET/api/simulation/attack-flowsAttack Flows200
POST/api/simulation/attack-flows/{flow_id}/resendResend Attack Flow200
GET/api/simulation/catalogCatalog200
POST/api/simulation/forward-logsForward Logs200
GET/api/simulation/logsLogs200
POST/api/simulation/manual-resultManual Result200
POST/api/simulation/planPlan200
POST/api/simulation/runRun200
DELETE/api/simulation/siem-destinationsClear Siem Destinations200
GET/api/simulation/siem-destinationsSiem Destinations200
POST/api/simulation/siem-destinationsSave Siem Destination200
GET/api/simulation/targetsTargets200

Authentication

20 operations.

MethodPathOperationSuccess
GET/api/auth/auditAuth Audit Events200
GET/api/auth/groupsList Groups200
POST/api/auth/groupsCreate Group201
DELETE/api/auth/groups/{group_id}Delete Group204
PATCH/api/auth/groups/{group_id}Update Group200
POST/api/auth/loginLogin200
POST/api/auth/logoutLogout200
GET/api/auth/meMe200
POST/api/auth/mfa/confirmConfirm Mfa200
POST/api/auth/mfa/setupSetup Mfa200
GET/api/auth/sessionsList Sessions200
POST/api/auth/sessions/revoke-allRevoke All My Sessions200
GET/api/auth/statusStatus200
GET/api/auth/usersList Users200
POST/api/auth/usersCreate Native User201
DELETE/api/auth/users/{user_id}Disable User204
PATCH/api/auth/users/{user_id}Update User200
POST/api/auth/users/{user_id}/mfa/disableDisable User Mfa200
POST/api/auth/users/{user_id}/passwordSet Password200
POST/api/auth/users/{user_id}/sessions/revokeRevoke User Session Set200

CVE Intelligence

16 operations.

MethodPathOperationSuccess
POST/api/cve/correlateRun Cve Correlation200
GET/api/cve/libraryCve Library200
GET/api/cve/related/actor/{actor_attack_id}Related Cves For Actor200
GET/api/cve/related/ioc/{indicator_id}Related Cves For Ioc200
GET/api/cve/related/technique/{attack_id}Related Cves For Technique200
GET/api/cve/sourcesCve Sources200
POST/api/cve/sync/allSync All Cves200
POST/api/cve/sync/epssSync Epss200
POST/api/cve/sync/github-advisoriesSync Github Security Advisories200
POST/api/cve/sync/kevSync Kev200
POST/api/cve/sync/nvdSync Nvd200
POST/api/cve/sync/nvd/cve-idsSync Nvd By Cve Ids200
POST/api/cve/sync/nvd/missing-cvssSync Missing Cvss200
POST/api/cve/sync/osv/packagesSync Osv Package Advisories200
GET/api/cve/{cve_id}Cve Detail200
GET/api/cve/{cve_id}/graphCve Graph200

Collection and Detection Pipeline

18 operations.

MethodPathOperationSuccess
GET/api/pipeline/auditAudit Events200
POST/api/pipeline/detections/generateGenerate201
POST/api/pipeline/detections/validateValidate200
GET/api/pipeline/detections/versionsDetection Versions200
POST/api/pipeline/import/atlasImport Atlas200
POST/api/pipeline/import/mispImport Misp200
POST/api/pipeline/import/stixImport Stix200
GET/api/pipeline/meMe200
GET/api/pipeline/observablesObservables200
POST/api/pipeline/observablesCreate Observable201
POST/api/pipeline/observables/{observable_id}/enrichEnrich200
POST/api/pipeline/rule-feeds/defaultsCreate Default Rule Feeds200
GET/api/pipeline/runsRuns200
GET/api/pipeline/sandbox/behaviorsSandbox Behaviors200
GET/api/pipeline/sourcesSources200
POST/api/pipeline/sourcesCreate Source201
PUT/api/pipeline/sources/{source_id}Update Source200
POST/api/pipeline/sources/{source_id}/runRun Source200

EMB3D

4 operations.

MethodPathOperationSuccess
POST/api/emb3d/assets/assessEmb3D Assess Assets200
GET/api/emb3d/assets/reportEmb3D Asset Report200
GET/api/emb3d/catalogEmb3D Catalog200
POST/api/emb3d/previewEmb3D Preview Asset200

Evidence-to-Detection Graph

16 operations.

MethodPathOperationSuccess
GET/api/evidence-graphQuery200
POST/api/evidence-graph/edgesCreate Edge201
DELETE/api/evidence-graph/edges/{edge_id}Delete Edge204
PATCH/api/evidence-graph/edges/{edge_id}Update Edge200
GET/api/evidence-graph/exportExport200
POST/api/evidence-graph/from-asset/{asset_id}From Asset200
POST/api/evidence-graph/from-ioc/{ioc_id}From Ioc200
POST/api/evidence-graph/from-malware/{case_id}From Malware200
POST/api/evidence-graph/from-report/{report_id}From Report200
POST/api/evidence-graph/from-simulation/{simulation_run_id}From Simulation200
GET/api/evidence-graph/gapsGaps200
POST/api/evidence-graph/nodesCreate Node201
DELETE/api/evidence-graph/nodes/{node_id}Delete Node204
PATCH/api/evidence-graph/nodes/{node_id}Update Node200
GET/api/evidence-graph/pathsPaths200
GET/api/evidence-graph/summarySummary200

Export

4 operations.

MethodPathOperationSuccess
GET/api/export/analysis/{session_id}Export Analysis Pdf200, 202
POST/api/export/analysis/{session_id}Export Analysis Pdf200, 202
GET/api/export/analysis/{session_id}/stixExport Analysis Stix200, 202
POST/api/export/layerExport Layer Pdf200

IOC Intelligence

30 operations.

MethodPathOperationSuccess
GET/api/ioc/actors/countsActor Ioc Counts Route200
GET/api/ioc/actors/{actor_id}Actor Ioc Route200
POST/api/ioc/actors/{actor_id}/enrich/otxEnrich Actor Otx Route200
GET/api/ioc/actors/{actor_id}/export.csvActor Ioc Csv Route200
GET/api/ioc/actors/{actor_id}/summaryActor Ioc Summary Route200
POST/api/ioc/enrich/ttpsEnrich Ioc Ttps Route200
POST/api/ioc/importImport Ioc Route200
POST/api/ioc/import/stixImport Ioc Stix Route200
POST/api/ioc/import/taxiiImport Ioc Taxii Route200
POST/api/ioc/investigateInvestigate Ioc Route200
GET/api/ioc/investigationsList Ioc Investigations200
DELETE/api/ioc/investigations/{session_id}Delete Ioc Investigation204
GET/api/ioc/investigations/{session_id}Get Ioc Investigation200
GET/api/ioc/libraryIoc Library Route200
GET/api/ioc/library/export/stixExport Ioc Library Stix Route200
GET/api/ioc/library/{indicator_id}/detailIoc Library Detail Route200
POST/api/ioc/opencti/pullOpencti Pull Route200
POST/api/ioc/opencti/pushOpencti Push Route200
GET/api/ioc/opencti/statusOpencti Status Route200
POST/api/ioc/opencti/syncOpencti Sync Route200
POST/api/ioc/reportImport Iocs From Report200
GET/api/ioc/sourcesSources200
POST/api/ioc/sourcesCreate Source200
DELETE/api/ioc/sources/{source_id}Delete Source204
PATCH/api/ioc/sources/{source_id}Update Source200
POST/api/ioc/sync/malpediaSync Malpedia Route200
POST/api/ioc/sync/otxSync Otx Route200
POST/api/ioc/sync/threatfoxSync Threatfox Route200
POST/api/ioc/sync/{source_id}Sync Source Route200
POST/api/ioc/virustotal/lookupVirustotal Lookup200

Knowledge

4 operations.

MethodPathOperationSuccess
GET/api/knowledge/articlesList Articles200
GET/api/knowledge/articles/{article_id}Get Article200
POST/api/knowledge/seedTrigger Seed200
GET/api/knowledge/statsStats200

MITRE Sync

6 operations.

MethodPathOperationSuccess
POST/api/sync/cveTrigger Cve Sync200
POST/api/sync/dynamic-dbTrigger Dynamic Db Sync200
POST/api/sync/iocTrigger Ioc Sync200
GET/api/sync/statusSync Status200
GET/api/sync/task/{task_id}Task Status200
POST/api/sync/triggerTrigger Sync200

MalwareGraph

26 operations.

MethodPathOperationSuccess
GET/api/malwaregraph/analysesList Analyses200
POST/api/malwaregraph/analysesCreate Analysis200
GET/api/malwaregraph/analyses/{job_id}Get Analysis200
POST/api/malwaregraph/analyses/{job_id}/ai-full-analysisAi Full Analysis200
POST/api/malwaregraph/analyses/{job_id}/debug-sessionsCreate Debug Session200
POST/api/malwaregraph/analyses/{job_id}/debug-workspacesCreate Debug Workspace200
POST/api/malwaregraph/analyses/{job_id}/decompilationCreate Decompilation200
GET/api/malwaregraph/analyses/{job_id}/files/previewFile Preview200
POST/api/malwaregraph/analyses/{job_id}/inject-fileInject File200
GET/api/malwaregraph/analyses/{job_id}/logsGet Analysis Logs200
POST/api/malwaregraph/analyses/{job_id}/obfuscation-analysisObfuscation Analysis200
GET/api/malwaregraph/analyses/{job_id}/reportGet Report200
POST/api/malwaregraph/analyses/{job_id}/runtime-debug-sessionsCreate Runtime Debug Session200
POST/api/malwaregraph/analyses/{job_id}/save-unpackedSave Unpacked200
GET/api/malwaregraph/analyses/{job_id}/stringsStrings Analysis200
POST/api/malwaregraph/analyses/{job_id}/unpackUnpack200
POST/api/malwaregraph/analyses/{job_id}/unpack/runtimeRuntime Unpack200
GET/api/malwaregraph/analyses/{job_id}/workflow-graphGet Workflow Graph200
GET/api/malwaregraph/debug-workspaces/{session_id}Get Debug Workspace200
POST/api/malwaregraph/debug-workspaces/{session_id}/ai-assistantDebug Workspace Ai Assistant200
POST/api/malwaregraph/debug-workspaces/{session_id}/stepStep Debug Workspace200
GET/api/malwaregraph/healthHealth200
POST/api/malwaregraph/llm/completeComplete Llm For Malwaregraph200
GET/api/malwaregraph/llm/providersProviders200
GET/api/malwaregraph/logsGet Service Logs200
POST/api/malwaregraph/runtime-debug-sessions/{session_id}/stepStep Runtime Debug Session200

Observability

4 operations.

MethodPathOperationSuccess
GET/api/observability/logsApi Logs200
GET/api/observability/metricsPrometheus Metrics200
GET/api/observability/summaryObservability Summary200
GET/api/observability/tracesRecent Traces200

Operational Intelligence

15 operations.

MethodPathOperationSuccess
GET/api/operations/detectionsDetections200
POST/api/operations/detectionsCreate Detection201
DELETE/api/operations/detections/{item_id}Delete Detection204
PUT/api/operations/detections/{item_id}Update Detection200
GET/api/operations/intakeIntake200
POST/api/operations/intakeCreate Intake201
DELETE/api/operations/intake/{item_id}Delete Intake204
PUT/api/operations/intake/{item_id}Update Intake200
GET/api/operations/investigationsInvestigations200
POST/api/operations/investigationsCreate Investigation201
DELETE/api/operations/investigations/{item_id}Delete Investigation204
PUT/api/operations/investigations/{item_id}Update Investigation200
GET/api/operations/tracked-actorsTracked Actors200
POST/api/operations/tracked-actorsTrack Actor201
DELETE/api/operations/tracked-actors/{item_id}Delete Tracked Actor204

RetroHunt

4 operations.

MethodPathOperationSuccess
POST/api/retrohunt/collectTrigger Collect200
GET/api/retrohunt/collect/{task_id}Collect Status200
GET/api/retrohunt/signalsList Signals200
GET/api/retrohunt/statsStats200

Saved Layers

4 operations.

MethodPathOperationSuccess
GET/api/layersList Layers200
POST/api/layersSave Layer201
DELETE/api/layers/{layer_id}Delete Layer204
GET/api/layers/{layer_id}Get Layer200

Sector Intelligence

8 operations.

MethodPathOperationSuccess
GET/api/sector/packsSector Packs200
GET/api/sector/packs/{sector_id}Sector Pack Detail200
GET/api/sector/regionsRegions200
GET/api/sector/relevanceRelevance200
GET/api/sector/sectorsSectors200
GET/api/sector/sourcesSources200
POST/api/sector/sync/misp-galaxySync Misp200
GET/api/sector/technologiesTechnologies200

Statistics

1 operation.

MethodPathOperationSuccess
GET/api/statistics/overviewStatistics Overview200

System

7 operations.

MethodPathOperationSuccess
GET/api/healthCheck API liveness and startup progress200
GET/api/readyCheck API and database readiness200
GET/api/system/capabilitiesList every supported API module and operation200
GET/api/system/selftestSelftest200
GET/api/system/startupStartup200
POST/api/system/taxonomy/normalizeNormalize Taxonomy200
GET/api/system/taxonomy/statusTaxonomy Status200

Threat Hunting

15 operations.

MethodPathOperationSuccess
GET/api/threat-hunting/huntsList Hunts200
POST/api/threat-hunting/huntsCreate Hunt201
DELETE/api/threat-hunting/hunts/{hunt_id}Archive Hunt Legacy — deprecated204
GET/api/threat-hunting/hunts/{hunt_id}Get Hunt200
PATCH/api/threat-hunting/hunts/{hunt_id}Update Hunt200
POST/api/threat-hunting/hunts/{hunt_id}/archiveArchive Hunt200
GET/api/threat-hunting/hunts/{hunt_id}/exportExport Hunt200
GET/api/threat-hunting/hunts/{hunt_id}/findingsList Findings200
POST/api/threat-hunting/hunts/{hunt_id}/findingsCreate Finding201
DELETE/api/threat-hunting/hunts/{hunt_id}/findings/{finding_id}Archive Finding Legacy — deprecated204
PATCH/api/threat-hunting/hunts/{hunt_id}/findings/{finding_id}Update Finding200
POST/api/threat-hunting/hunts/{hunt_id}/findings/{finding_id}/archiveArchive Finding200
GET/api/threat-hunting/hunts/{hunt_id}/query-versionsQuery Versions200
GET/api/threat-hunting/statsStats200
GET/api/threat-hunting/templatesTemplates200

Threat Hunting AI

4 operations.

MethodPathOperationSuccess
POST/api/threat-hunting/ai/assistAssist200
GET/api/threat-hunting/ai/historyHistory200
POST/api/threat-hunting/ai/hypothesesHypotheses200
GET/api/threat-hunting/ai/providersProviders200

Threat Hunting Query Library

6 operations.

MethodPathOperationSuccess
GET/api/query-librarySearch200
GET/api/query-library/autocompleteGet Autocomplete200
POST/api/query-library/build-from-iocBuild From Ioc200
GET/api/query-library/facetsGet Facets200
POST/api/query-library/syncSync From Detection Feeds200
GET/api/query-library/{item_id}Get Item200

Threat Radar

46 operations.

MethodPathOperationSuccess
GET/api/threat-radar/asset-scanner/providersAsset Scanner Providers200
GET/api/threat-radar/casesList Cases200
GET/api/threat-radar/cases/{case_id}Get Case200
POST/api/threat-radar/cases/{case_id}/create-detection-requirementCreate Detection201
POST/api/threat-radar/cases/{case_id}/create-huntCreate Hunt201
POST/api/threat-radar/cases/{case_id}/create-ir-escalationCreate Ir201
POST/api/threat-radar/cases/{case_id}/create-psirt-taskCreate Psirt201
POST/api/threat-radar/cases/{case_id}/escalateEscalate Case200
POST/api/threat-radar/cases/{case_id}/generate-reportGenerate Case Report201
GET/api/threat-radar/cases/{case_id}/graphGet Case Graph200
POST/api/threat-radar/cases/{case_id}/scoreRescore Case200
POST/api/threat-radar/evidenceCreate Evidence201
POST/api/threat-radar/exposure/classifyClassify Exposure200
POST/api/threat-radar/exposure/ingestIngest Exposure201
POST/api/threat-radar/exposure/planExposure Monitoring Plan200
GET/api/threat-radar/exposure/providersExposure Providers200
GET/api/threat-radar/product-exposureProduct Exposure200
POST/api/threat-radar/product-mapCreate Product Map201
GET/api/threat-radar/queues/{queue}Workflow Queue200
GET/api/threat-radar/signalsList Signals200
POST/api/threat-radar/signalsCreate Signal201
GET/api/threat-radar/signals/{signal_id}Get Signal200
POST/api/threat-radar/signals/{signal_id}/triageTriage Signal200
GET/api/threat-radar/sourcesList Sources200
POST/api/threat-radar/sourcesCreate Source201
GET/api/threat-radar/spacesList Company Spaces200
POST/api/threat-radar/spacesCreate Company Space201
GET/api/threat-radar/spaces/metricsCompany Space Metrics200
GET/api/threat-radar/spaces/{space_id}Get Company Space200
POST/api/threat-radar/spaces/{space_id}/ai-assistantCompany Space Ai Assistant200
GET/api/threat-radar/spaces/{space_id}/alertsList Space Alerts200
POST/api/threat-radar/spaces/{space_id}/alerts/{alert_id}/statusUpdate Alert Status200
GET/api/threat-radar/spaces/{space_id}/assetsList Space Assets200
POST/api/threat-radar/spaces/{space_id}/assetsCreate Space Asset201
PUT/api/threat-radar/spaces/{space_id}/assets/{asset_id}Update Space Asset200
GET/api/threat-radar/spaces/{space_id}/assets/{asset_id}/intelligenceGet Space Asset Intelligence200
GET/api/threat-radar/spaces/{space_id}/assets/{asset_id}/scansList Asset Scans200
POST/api/threat-radar/spaces/{space_id}/assets/{asset_id}/scansCreate Asset Scan201
GET/api/threat-radar/spaces/{space_id}/assets/{asset_id}/scans/{scan_id}Get Asset Scan200
POST/api/threat-radar/spaces/{space_id}/dashboardsCreate Space Dashboard201
POST/api/threat-radar/spaces/{space_id}/dashboards/generateGenerate Space Dashboard201
POST/api/threat-radar/spaces/{space_id}/monitorsCreate Space Monitor201
POST/api/threat-radar/spaces/{space_id}/monitors/{monitor_id}/runRun Space Monitor200
POST/api/threat-radar/spaces/{space_id}/searchSearch Threat Monitor200
GET/api/threat-radar/unified/entitiesUnified Entities200
GET/api/threat-radar/watchlists/{watchlist}Watchlist200

Troubleshooting

1 operation.

MethodPathOperationSuccess
POST/api/troubleshooting/assistantAssistant200

Unified Intelligence RAG

13 operations.

MethodPathOperationSuccess
POST/api/rag/assistAssist200
GET/api/rag/company-spacesCompany Spaces200
GET/api/rag/entity/{source_type}/{source_id}Entity200
GET/api/rag/index-runsIndex Runs200
GET/api/rag/profilesClient Profiles200
POST/api/rag/profilesCreate Client Profile201
DELETE/api/rag/profiles/{profile_id}Delete Client Profile204
PUT/api/rag/profiles/{profile_id}Update Client Profile200
POST/api/rag/proposals/{proposal_id}/confirmConfirm Proposal200
GET/api/rag/providersProviders200
POST/api/rag/reindexReindex202
POST/api/rag/searchSearch200
GET/api/rag/statusStatus200