API Reference

Integrations API

Overview

Manage external provider connections programmatically.

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

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

Integrations API workflow

Integrations API workflow

Typical integration pattern

Step-by-step procedure

Confirm access

Verify organization membership and role permissions in Admin Center.

Confirm API key or SSO session is scoped to the correct tenant.

Apply this guidance

Follow Console navigation paths and API examples in this document.

Use staging project and environment IDs for first-time integration tests.

Verify outcomes

Check Operate → Runs, Quality areas, or API responses for expected results.

Update team runbooks when your stack requires environment-specific variations.

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

  • 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
/integrations
List connected providers and connection health.
POST
/integrations
Initiate OAuth or token-based provider connection.
GET
/integrations/{id}
Fetch integration scopes and last sync status.
PATCH
/integrations/{id}
Refresh tokens or update webhook configuration.
DELETE
/integrations/{id}
Revoke provider access and remove configuration.
POST
/integrations/{id}/test
Verify connectivity with a probe request.

Was this page helpful?

Integrations API | Zof AI Documentation