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.

Prerequisites

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

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.

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?