API Reference

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.

Prerequisites

• Organization API key with appropriate permissions
• Understanding of REST and JSON
• Staging environment for integration testing before production keys

Establish the API contract before integration

Confirm the supported base URL, API version, authentication method, operation permissions, and request and response schema for your deployment. A documentation example is not evidence that an endpoint is enabled for every account.

Start with a read-only request to an authorized test resource. Record status, response shape, and correlation information, then test a denied request. For writes, establish idempotence and how you will reconcile an accepted operation after a lost response before adding retries.

Related documentation