Skip to main content

AI & Threat Intelligence API

Everything in this section is available over the REST API. API Reference covers authentication and conventions; Swagger at https://<your-host>/api/docs is exhaustive.

export OFFLOAD_HOST="https://your-instance.example.com"
export OFFLOAD_API_KEY="osk_xxxxxxxxxxxxxxxxxxxx"

Send the key as X-API-Key; calls are scoped to the key's team.

Threat Intelligence

TaskEndpointNotes
Dashboard · indicatorsGET /api/threat-intelligence/dashboard · GET /api/threat-intelligence/indicators?ioc_type=&severity=&confidence=&search=&limit= · POST /api/threat-intelligence/searchRead: any member
Add an indicatorPOST /api/threat-intelligence/indicators {ioc_type, value, severity, description, …}Manage Threat Intelligence
CorrelatePOST /api/threat-intelligence/correlate {indicator}Assets, related indicators, actors, campaigns
Prioritise CVEsPOST /api/threat-intelligence/vulnerabilities/prioritize {cve_ids[]} · POST /api/enhanced-threat-intelligence/vulnerabilities/prioritize-realScore 50 + KEV 25 + indicators ≤ 15 + actors ≤ 10 + campaigns ≤ 10 + critical 10
FeedsGET /api/threat-intelligence/feeds · GET …/feeds/{feed_id}/details · POST …/feeds/process/{feed_id} · POST …/feeds/{feed_id}/refresh · PUT …/feeds/{feed_id} {api_key, …} · PUT …/feeds/{feed_id}/enable · …/disable · POST …/feeds/test-connectionConfiguration needs Manage Threat Intelligence
MITRE heatmap · alertsGET /api/threat-intelligence/mitre-heatmap · GET /api/threat-intelligence/alerts
Landscape reportsPOST /api/threat-intelligence/landscape-report {report_period_days: 7|30|90, report_format: executive|technical|comprehensive} · GET …/landscape-reports · GET …/landscape-reports/{report_id}
Actors · campaignsPOST · GET /api/enhanced-threat-intelligence/actors · GET · PUT · DELETE …/actors/{actor_id} · same under …/campaignsTLP classification, ATT&CK techniques; API-only today
Alert rules · huntingGET · POST …/alert-rules · POST …/alert-rules/{rule_id}/toggle · GET · POST …/hunting-queries · POST …/hunting-queries/{query_id}/execute
Alerts workflowPOST · GET …/alerts · GET …/alerts/{alert_id} · PUT …/alerts/{alert_id}/status · …/assign · POST …/alerts/{alert_id}/comments · GET …/ioc-sightings
Import · exportPOST …/bulk-import {format: csv|json|stix, data} · POST …/bulk-export {format: stix|csv|json, ioc_type?}
AgingGET · PUT …/ioc-aging-config {default_ttl_days, ttl_by_ioc_type, decay_rate_per_day, minimum_confidence} · POST …/ioc-aging/apply-decayDefaults 90 days · 0.5 %/day · floor 10
VocabulariesGET …/tlp-classifications · GET …/kill-chain-phases

Security Command Center

TaskEndpointNotes
Dashboard · status · triggers · logGET /api/ai-agents/dashboard · GET /api/ai-agents/status · GET /api/ai-agents/triggers · GET /api/ai-agents/audit-log?limit=Run AI Agent
TriagePOST /api/ai-agents/triage/findings {scan_id: "<run id>" | "latest"} or {findings: [...]} · POST /api/ai-agents/triage/worklist/run {scan_id?, limit?} · GET /api/ai-agents/triage/worklist?action=&limit= · POST …/triage/worklist/{finding_id}/decision {action: fix|defer|dedup|suppress, decision?}Run AI Agent
Incidents · FP/TPPOST …/triage/incidents/run · GET …/triage/incidents · POST …/triage/fp-assess/run · POST …/triage/fp-assess/code · GET …/triage/fp-assessments · GET …/triage/fp-accuracyAdvisory; never suppresses
Auto-fix hand-offGET …/triage/auto-fix-queue · POST …/triage/auto-fix/process · POST …/triage/worklist/{finding_id}/auto-fix · GET · POST …/triage/auto-fix/settings {enabled}Settings need Manage Team
Remediation · compliance agentsPOST /api/ai-agents/remediation/generate {finding} · POST /api/ai-agents/compliance/assess · …/compliance/evidence · …/compliance/gap-analysis · GET …/compliance/evidence-templates
Threat hunt · advisorPOST /api/ai-agents/threat-hunt/execute {action: hunt|correlate|generate_hypothesis} · POST /api/ai-agents/posture/ask {question} · POST …/posture/briefing {period?} · GET …/posture/benchmark · GET …/posture/priorities
Auto-Fix EnginePOST /api/compliance-engine/remediation/process-findings {all_active?} · GET …/remediation/actions?status=pending|approved|executed|denied|rolled_back&limit= · GET …/remediation/stats · POST …/remediation/actions/{action_id}/approve · …/deny {reason} · …/execute · …/rollbackExecute Remediations; status=pending covers both awaiting-approval spellings

AI Governance

TaskEndpointNotes
Dashboard · postureGET /api/ai-governance/dashboard · GET …/compliance-score · GET …/gap-analysis · GET …/certification-readiness · GET …/compliance-dashboard · GET …/coverage-summary
RegistryGET · POST /api/ai-governance/models {name, description, owner, type, risk_level, use_case, data_sources[], deployment_status, business_unit, last_assessment_date?, next_review_date?} · GET · PUT · DELETE …/models/{model_id}Manage Assessments throughout
Assessments · testsGET · POST …/risk-assessments · GET · POST …/bias-tests · POST …/models/{model_id}/run-bias-tests · GET …/models/{model_id}/bias-test-results · GET · POST …/impact-analysis · POST …/automated-tests/{fairness|privacy|data-quality|comprehensive}
Structured assessmentsPOST …/assessments/draft · GET …/assessments/{assessment_id}/draft · POST …/assessments/{assessment_id}/submit · …/evidence · …/remediation-tasks · GET …/assessments/{assessment_id}/executive-summary · …/compliance-mapping · …/detailed-report · GET …/risk-categories · …/assessment-frameworks
OperationsGET · POST …/incidents · GET · POST …/human-oversight · GET · POST …/training-records · GET …/audit-trail
MonitoringPOST …/models/{model_id}/health-score · …/drift-detection · …/performance-trend · …/monitoring-alert · GET …/models/{model_id}/monitoring-summary
Helpers · reportsPOST …/assessment-helper/{suggest-scores|suggest-mitigations|validate-completeness|generate-summary} · POST …/generate-report {report_type, format}Helpers use the configured LLM
ISO 42001 exportsGET /api/common-controls/soa/iso_42001?format=xlsx · GET /api/evidence-completion/auditor-package/iso_42001Statement of Applicability · auditor ZIP

Discovery, AIBOM and testing

TaskEndpointNotes
DiscoveryPOST /api/ai-spm/discover → job; GET /api/jobs/{job_id} · GET /api/ai-spm/dashboardCloud asset inventory + LLM configuration
ClassifyPOST /api/ai-spm/classify/{model_id} {use_case?, sector?, data_types?, decision_impact?} · GET /api/ai-spm/risk-tiers · GET /api/ai-spm/complianceEU AI Act tier + NIST AI RMF
Prompt testsPOST /api/ai-spm/prompt-test/{model_id} {api_endpoint?, api_key?, custom_payloads?} · GET …/prompt-test/results/{test_id} · GET /api/ai-spm/supply-chain/{model_id}Key is used for the run only
AIBOMGET /api/v1/aibom/summary · GET /api/v1/aibom/components?component_type=&provider=&owner=&environment=&state=active|stale|all&needs_confirmation=&page= · GET …/components/{component_id} · PATCH …/components/{component_id}/governance (owner, environment, confirm / dismiss) · GET …/relationships/{component_id} · GET …/scans · POST …/scans/sbom (reconcile now)

Knowledge Base

TaskEndpointNotes
Sections · documentsGET · POST /api/knowledge-base/sections · POST /api/knowledge-base/upload (multipart: file, title, section_id, document_type, sensitivity_level, description, tags) · GET …/documents · DELETE …/documents/{document_id} · POST …/documents/reprocess · …/reprocess-extractionUploads need Manage Assessments
Ask · searchPOST /api/knowledge-base/ask {question, section_id?, document_id?} · POST …/search {query, section_id?} · GET …/questions · POST …/questions/{question_id}/feedback {helpful} · GET …/templatesAnswers carry sources[], confidence_score, confidence_level
QuestionnairePOST /api/knowledge-base/questionnaire/detect-columns (multipart) · POST …/questionnaire/fill (multipart: file, detail_level: short|standard|detailed) → GET …/questionnaire/fill/{fill_id}/download · GET · PUT …/questionnaire/settings {refinement_enabled, default_detail_level, max_words} · POST …/questionnaire/refine
Review queue · bankGET /api/review/queue?priority=&status= · GET /api/review/summary · GET /api/review/items/{item_id} · POST …/items/{item_id}/approve · …/edit {answer} · …/reject · GET · POST /api/question-bank/entries · POST /api/question-bank/importApproved answers write back to the bank
Analytics · configGET /api/knowledge-base/analytics · GET · PUT …/config · GET …/ai-providers · LLM providers: see Reports & AI API

Permissions

ActionPermission
Read the threat dashboard, indicators, feeds, heatmap, reports, alertsany authenticated team member
Configure feeds, add indicators, correlate, prioritise, generate reports, actors / campaigns / rules / hunting, aging, import / exportManage Threat Intelligence (manage_threat_intelligence) — Security Manager
Run agents: triage, worklist decisions, incidents, FP/TP, hand-offs, remediation drafting, threat hunt, advisorRun AI Agent (run_ai_agent)
Team auto-fix opt-inManage Team
Approve / deny / execute / roll back Auto-Fix actions, process findingsExecute Remediations (execute_remediations)
AI governance registry, assessments, tests, incidents, oversight, training, reports; discovery, classification, prompt tests, AIBOM; Knowledge Base uploads, questions, questionnaire fill, review queueManage Assessments (manage_assessments)
Knowledge Base library, analytics, templatesany authenticated team member

See Authentication for key scopes and Conventions for pagination, error shapes and rate limits.