Stackurity Start free trial

API reference Reports

Reports

5 operations. Base URL https://app.stackurity.dev/api/v1 on Stackurity Cloud; see authentication.

Audit events

GET /audit

Role: viewer

Parameters

ParameterInTypeDescription
object_typequerystring
object_idquerystring
limitquerystringPage size (default 100, at most 500)
offsetquerystringItems to skip

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Patch-management evidence for a period (licensed edition)

GET /reports/evidence

Role: viewer

Patch-management evidence for a period (dates, to inclusive; default the last 30 days, at most a year): assets and their collection status, hosts needing a reboot, evaluation gaps, open findings by severity and priority, overdue findings, findings remediated in the period (upgraded, fixed or removed) with the share resolved within their deadline and the median days from first detection to resolution, findings closed without remediation (advisory withdrawn or changed) counted apart, every active exception with its reason, mitigation and expiry, and drift for each replica_of pair

Parameters

ParameterInTypeDescription
fromquerystring
toquerystring

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

The audit evidence pack for a period (licensed edition)

GET /reports/evidence-pack

Role: viewer

The audit evidence pack for a period, mapped to framework controls: SOC 2 CC7.1 and CC8.1 and ISO 27001:2022 A.8.8 and A.8.9 (Pro), and PCI DSS 4.0 and the EU Cyber Resilience Act with the Compliance add-on (else 402). Monitoring with checked hours, findings at the start and end with deadline status, time to fix by priority, exceptions with requester and approver, closures and policies. It is evidence for the controls, never a statement of compliance. format=zip adds CSV tables and a SHA-256 manifest (and, with the add-on, SBOM and VEX files). See docs/api.md, "Audit evidence pack"

Parameters

ParameterInTypeDescription
fromquerystringFirst day (YYYY-MM-DD); default 90 days before to
toquerystringLast day, inclusive (YYYY-MM-DD); default today
frameworksquerystringComma-separated: soc2, iso27001_2022, pci_dss_4_0, eu_cra; default every one the plan includes
formatquerystringjson (default), pdf or zip
labelquerystringThe period's name, such as 2026-Q3

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Remediation outcomes over the last days (1 to 365, default 90)

GET /reports/outcomes

Role: viewer

Remediation outcomes over the last days (1 to 365, default 90). resolved, time to remedy and SLA count remediated and removed findings only; findings closed with nothing changed on the asset (advisory withdrawn or changed, still affected after an upgrade, no longer evaluated) are counted apart in closed_not_remediation by resolution_kind

Parameters

ParameterInTypeDescription
daysquerystring

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Monitored assets against the organisation's limit

GET /usage

Role: viewer (organisation-wide)

Monitored assets against the organisation's limit: monitored, limit (null: none), at_limit, by_kind, stale, workloads (not counted), refused (the most recent new assets refused at the limit) and refused_recently (last 7 days). Also projects, project_limit, projects_at_limit, read_only (since, reason), report_mode (full, trial) and plan (the plan limits and their use, or null). At the limit, requests that would create an asset answer 402 with code asset_limit, a new project 402 project_limit, a new rule, channel, team, API token or member past the plan's limits 402 plan_limit; while read-only, uploads, enrollment, integrations, checks and notifications answer 402 read_only

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError