API Reference

Schedules API

Recurring validation.

Overview

Configure recurring validation with cron expressions and targets.

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

Schedules workflow

Schedules 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
/schedules
List active and paused schedules.
POST
/schedules
Define cron, target suite or cases, and environment.
GET
/schedules/{id}
Get schedule configuration and last run summary.
PATCH
/schedules/{id}
Modify cron, targets, or enabled state.
DELETE
/schedules/{id}
Remove schedule; in-flight runs continue to completion.
POST
/schedules/{id}/pause
Temporarily pause without deleting configuration.

Was this page helpful?