API Reference

Applications API

Application CRUD.

Overview

Register and manage systems under test linked to teams and environments.

Use organization-scoped API keys with Bearer authentication. All responses are JSON unless downloading binary report artifacts. List endpoints support cursor pagination; mutating operations accept Idempotency-Key headers.

Who should read this

  • Engineers building automation against Zof for CMDB sync, CI gates, reporting, and integration health checks.

Prerequisites

  • API key with read access minimum; write operations require appropriate role
  • Familiarity with REST and JSON

Applications workflow

Applications workflow

Typical integration pattern

Best practices

  • Test mutations in staging before production automation
  • Cache resource IDs from list responses; avoid hard-coding in multiple services
  • Subscribe to webhooks for run completion instead of polling where possible

API operations

GET
/applications
Return paginated applications visible in your organization.
POST
/applications
Register a new application with name, type, team, and environment URLs.
GET
/applications/{id}
Fetch application metadata, linked projects, and feature hierarchy.
PATCH
/applications/{id}
Update name, description, environment URLs, or team ownership.
DELETE
/applications/{id}
Archive or remove application per organization retention policy.

Was this page helpful?