Release gate via API Zof Documentation

Overview

Query gate status before triggering deploy job.

Examples use staging environments and synthetic identifiers. Replace project IDs, suite names, and webhook URLs with your organization values.

Prerequisites

Organization API key or authenticated CLI
Staging environment for safe experimentation

Step-by-step procedure

Prepare environment

Store ZOF_API_KEY in CI secrets or local env.

Confirm target project and suite IDs in Console.

Apply pattern

Copy example configuration into your pipeline or service.

Adjust environment names and notification channels.

Validate

Run once manually before enforcing gates.

Capture run ID in runbook for support reference.

Example implementation

STATUS=$(curl -s https://api.zof.ai/v1/release-gates/${GATE_ID} \
  -H "Authorization: Bearer $ZOF_API_KEY" | jq -r .status)
if [ "$STATUS" != "passed" ]; then exit 1; fi