K-Shield API Reference

K-Shield exposes REST APIs for security scanning, SCAP compliance, threat intelligence, audit-stream, nmap/rkhunter monitoring, VM eligibility and scanning, remediation, and administration.

Raw OpenAPI spec

The K-Shield OpenAPI (Swagger 2.0) spec is served alongside the karios-core spec for use by IaC tools, SDK generators, and AI assistants:

Base URL and authentication

All K-Shield endpoints require a Bearer token:

curl -H "Authorization: Bearer $KARIOS_TOKEN" \
  https://<your-karios-cluster>/api/v1/security/health

Endpoint groups

K-Shield endpoints are organised primarily under two top-level URL prefixes:

  • /api/v1/security/* - security scanning + monitoring + compliance

  • /api/v1/system/* - system information + inventory

A small number of root-level utility endpoints (/metrics, /security/health, /api/v1/users) exist for operational purposes and sit outside those two prefixes.

Common categories:

URL prefix

Coverage

/api/v1/security/dc/*

Datacenter-wide aggregation (compliance trend, risk distribution, score histogram, top vulnerabilities, node status, nmap and rkhunter summaries)

/api/v1/security/nmap/*

Nmap scan history, port details, risk timelines (per-node and flat)

/api/v1/security/rkhunter/*

Rkhunter scan execution, results, historical reports

/api/v1/security/audit-stream/*

Audit stream configuration, activity, metrics, raw lines, status

/api/v1/security/threat-intel/*

Threat intelligence inventory, sources, precheck, refresh

/api/v1/security/compliance/*

SCAP compliance results (Day-0 and ongoing)

/api/v1/security/vm-scans/*

VM security scans (single and multi-VM), scheduling, cancellation

/api/v1/security/multi-vm-scans/*

Multi-VM scan orchestration, history, scheduling

/api/v1/security/scan/*

Node-level scan execution, cancellation, active-scan tracking

/api/v1/security/remediation/*

Vulnerability and internal finding remediation triggers

/api/v1/security/resource-policies

Resource policy read + update (GET, PUT)

/api/v1/security/scap-profiles / upload/scap-profiles

Custom SCAP profile upload and management

/api/v1/system/*

System info, findings, stats, recent scans, summary

Programmatic consumption

For IaC tools (OpenAPI Generator, kiota, autorest, Terraform provider generators) fetch the raw YAML directly:

curl -O https://docs.karios.com/_static/api-specs/karios-security-service.yaml

Note on schemas

Path and method information for every endpoint is verified from the live router registrations in karios-security-service main. Full request and response schemas are being progressively added via swaggo annotations in the source; a rolling docs refresh will pick those up.