Skip to main content

Module api

Module api 

Source
Expand description

REST API data models

§Runtime scope

  • Build: opt-in via platform-models.
  • Execution: host/library only; no repository runtime caller.
  • Default termivar scan: no.
  • Support: experimental/scaffold.

See docs/internals/runtime-map.md.

Request/response data contracts only. This module does not bind a listener or route HTTP requests.

Structs§

ApiResponse
API Response wrapper
FindingFilter
Finding filter for queries
ScanConfigRequest
Uninterpreted host configuration metadata.
ScanResultResponse
Scan result response
ScanStatus
Scan status response
StartScanRequest
API Request to start a new scan
StatsResponse
Statistics response

Enums§

ApiError
API error types
ScanStatusType
Scan status types