List reports

Overview

List generated reports by scope and time range. Requires Bearer authentication scoped to your organization.

Operation: GET /reports. Base URL: https://api.zof.ai/v1. Idempotent GET requests may be retried on 5xx; use pagination cursors for list operations.

Who should read this

• Platform engineers integrating CI/CD, internal tooling, or data pipelines with Zof.

Prerequisites

• Valid organization API key with permission for this resource
• Resource ID when path includes {id}, copy from Console or list endpoint
• Staging environment for first integration test

When to use this workflow

• Invoke list reports from deployment pipelines or scheduled jobs
• Synchronize Zof state with internal CMDB or release management tools
• Automate workflows that would otherwise require Console manual steps

Step-by-step procedure

Key concepts

Path parameter {id}

Replace with resource identifier returned from create or list operations.

Idempotency-Key

Optional header on POST; duplicate requests with same key return original result.

Request ID

Response header X-Request-Id for support escalation.

Best practices

• Use idempotency keys for POST operations in automation
• Handle 429 responses with exponential backoff and jitter
• Log X-Request-Id from response headers for support escalation
• Test against staging project IDs before production automation

Common issues

404 on {id}

Resource deleted, wrong organization scope, or typo in ID.

403 Forbidden

API key role lacks permission; use service account with appropriate role.

409 Conflict

Illegal state transition, e.g., canceling a completed run.

Example request

GET https://api.zof.ai/v1/reports
Authorization: Bearer $ZOF_API_KEY

API operations

Related documentation