API Reference

Projects API

Project CRUD endpoints.

Overview

Projects are the top-level container for reliability initiatives: requirements, scenarios, cases, suites, and run history. The API supports full CRUD for automation and CMDB synchronization.

Each project links to an application URL, team ownership, and testing categories from the Console wizard.

Who should read this

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

Prerequisites

API key with projects:read; projects:write for mutations

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

List existing

GET /v1/projects?limit=50 for paginated inventory.

Sync IDs to internal service catalog if needed.

Create or update

POST /v1/projects for new initiative.

PATCH /v1/projects/{id} for metadata changes after wizard completion.

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.

Create project

POST /v1/projects
{
  "name": "Payments Reliability Q3",
  "application_url": "https://staging.example.com",
  "description": "Card and wallet flows"
}

API operations

GET

/projects

List projects (paginated)

POST

/projects

Create project with name, application_url, description

GET

/projects/{id}

Retrieve project by ID

PATCH

/projects/{id}

Update metadata

DELETE

/projects/{id}

Archive or delete per org policy

Was this page helpful?