kf schedule
Create, pause, resume, and cancel tenant job schedules.
kf schedule cancel-job
Cancel a recurring schedule by moving it to DISABLED.
Cancel a recurring schedule by moving it to DISABLED. This is a reversible audit record, not a hard delete.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--schedule-id <value> | yes | Schedule id. |
--reason <value> | no | Reason. |
Example
kf schedule cancel-job --tenant tnt_demo --actor-type USER --actor-id usr_sam --schedule-id <value>kf schedule pause-job
Pause a recurring schedule without deleting it.
Pause a recurring schedule without deleting it. Existing jobs remain auditable; no new planned runs are materialized while paused.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--schedule-id <value> | yes | Schedule id. |
--reason <value> | no | Reason. |
Example
kf schedule pause-job --tenant tnt_demo --actor-type USER --actor-id usr_sam --schedule-id <value>kf schedule resume-job
Resume a paused or errored schedule.
Resume a paused or errored schedule. Optionally provide nextRunOn to control the first resumed planned run.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--schedule-id <value> | yes | Schedule id. |
--next-run-on <value> | no | ISO date/time |
--reason <value> | no | Reason. |
Example
kf schedule resume-job --tenant tnt_demo --actor-type USER --actor-id usr_sam --schedule-id <value>kf schedule upsert-job
Create or update a tenant-owned recurring schedule.
Create or update a tenant-owned recurring schedule. Schedules materialize deterministic jobs for ingestion, extracts, analytics, reconciliation, retention, and connector health.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--schedule-id <value> | no | Schedule id. |
--schedule-key <value> | yes | Schedule key. |
--job-type <value> | yes | Job type. |
--schedule-type <value> | yes | Schedule type. |
--schedule-config <value> | yes | Schedule config. |
--payload-template <value> | no | Payload template. |
--max-attempts <value> | no | Max attempts. |
--next-run-on <value> | yes | ISO date/time |
--status <value> | no | Status. |
--status-reason <value> | no | Status reason. |
Example
kf schedule upsert-job --tenant tnt_demo --actor-type USER --actor-id usr_sam --schedule-key <value> --job-type <value> --schedule-type <value> --schedule-config <value> --next-run-on <value>