Developers
API Reference
REST API for programmatic access to projects, runs, agents, and reports.
Overview
The Zof REST API provides programmatic access to the same reliability operations available in the Console: projects, runs, agents, reports, schedules, integrations, and webhooks. All requests use HTTPS, JSON bodies, organization-scoped API keys, and standard HTTP semantics.
Use the API to trigger validation from CI/CD pipelines, synchronize project metadata with internal tools, export run results to data warehouses, and automate webhook-driven workflows. SDKs wrap common patterns with typed clients, retries, and pagination helpers.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
Prerequisites
- Organization API key with appropriate permissions
- Understanding of REST and JSON
- Staging environment for integration testing before production keys
When to use this workflow
- Onboarding new team members to Zof terminology and workflows
- Authoring internal runbooks aligned with Console labels
- Designing CI/CD or webhook integrations against documented behavior
Step-by-step procedure
Confirm access
Verify organization membership and role permissions in Admin Center.
Confirm API key or SSO session is scoped to the correct tenant.
Apply this guidance
Follow Console navigation paths and API examples in this document.
Use staging project and environment IDs for first-time integration tests.
Verify outcomes
Check Operate → Runs, Quality areas, or API responses for expected results.
Update team runbooks when your stack requires environment-specific variations.
Key concepts
- Organization scope
- All Zof Console and API operations are isolated to your authenticated tenant.
- Governed execution
- Agent output and remediation follow policy packs with human approval when configured.
Best practices
- Validate changes in staging before applying release gates to production.
- Include run IDs and timestamps when escalating issues to support or auditors.
- Align internal runbook terminology with Zof Console UI labels for clarity.
Was this page helpful?
