API Reference

Reports

Overview

Generate and download reliability reports for stakeholders.

Use organization-scoped API keys with Bearer authentication. All responses are JSON unless downloading binary report artifacts. List endpoints support cursor pagination; mutating operations accept Idempotency-Key headers.

Who should read this

  • Engineers building automation against Zof for CMDB sync, CI gates, reporting, and integration health checks.

Prerequisites

  • API key with read access minimum; write operations require appropriate role
  • Familiarity with REST and JSON

Reports workflow

Reports workflow

Typical integration pattern

Best practices

  • Test mutations in staging before production automation
  • Cache resource IDs from list responses; avoid hard-coding in multiple services
  • Subscribe to webhooks for run completion instead of polling where possible

API operations

GET
/reports
List generated reports by scope and time range.
POST
/reports
Generate report for project, release, or date window.
GET
/reports/{id}
Fetch report metadata and summary metrics.
GET
/reports/{id}/download
Download PDF or structured export.

Was this page helpful?