Documentation menu

API reference

6 operations in pm-schedules. Raw spec: openapi.json.

GET/api/v1/pm-schedules

GET /api/pm-schedules — every schedule, next-run ordered.

Responses

StatusDescription
200

Security: bearer

POST/api/v1/pm-schedules

POST /api/pm-schedules — create a recurring-ticket template.

Request body

CreateScheduleRequest

Responses

StatusDescription
200
404board not found
409duplicate schedule name or idempotency key reused
422invalid cadence shape

Security: bearer

GET/api/v1/pm-schedules/{id}

GET /api/pm-schedules/{id}

Parameters

NameInTypeRequiredDescription
idpathstringYes

Responses

StatusDescription
200
404schedule not found

Security: bearer

PATCH/api/v1/pm-schedules/{id}

PATCH /api/pm-schedules/{id} — edit template/cadence/enabled. A cadence edit re-materializes `next_run_at` from the new shape.

Parameters

NameInTypeRequiredDescription
idpathstringYes

Request body

UpdateScheduleRequest

Responses

StatusDescription
200
404schedule not found
409version conflict or duplicate name
422invalid cadence shape

Security: bearer

DELETE/api/v1/pm-schedules/{id}

DELETE /api/pm-schedules/{id} — removes the schedule. Existing generated tickets are unaffected (templates are blueprints).

Parameters

NameInTypeRequiredDescription
idpathstringYes

Responses

StatusDescription
200
404schedule not found

Security: bearer

GET/api/v1/pm-schedules/{id}/runs

GET /api/pm-schedules/{id}/runs — the append-only run ledger (the run record; the worker emits nothing).

Parameters

NameInTypeRequiredDescription
idpathstringYes

Responses

StatusDescription
200
404schedule not found

Security: bearer