Runs API

Overview

Runs execute validation against selected cases or suites. Monitor status, fetch logs, cancel in-flight runs, and download artifacts programmatically for CI gates and reporting pipelines.

Terminal statuses: passed, failed, error, canceled. Poll GET /runs/{id} or subscribe to run.completed webhook for completion.

Who should read this

• QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.

Prerequisites

• project_id from Console or projects API
• Reviewed test case IDs or suite ID
• Environment matching deployment target

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

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.

Start run

POST /v1/runs
{
  "project_id": "proj_abc123",
  "environment": "staging",
  "test_case_ids": ["tc_login_001", "tc_checkout_014"]
}

API operations