Run a schedule once now; returns the run immediately.

Runs the schedule once now, outside its timing: its profiles open and its script drives them. Refused while the schedule already has a run in progress. Returns the run at once; read its result with GET /v1/runs/:id.

post/v1/schedules/{id}/run

Request

  • Base URL: http://127.0.0.1:10108
  • URL: http://127.0.0.1:10108/v1/schedules/{id}/run
  • Auth: HTTP bearer

Path parameters

idstring required

Schedule id (uuid), as listed by GET /v1/schedules.

Response

The run as recorded now, still running; poll GET /v1/runs/:id with its id.

completedAtstring date-time nullable required
errorstring nullable required
idstring uuid required
profileIdsstring[] required
profilesDoneinteger required
profilesFailedinteger required
profilesTotalinteger required
scheduleIdstring uuid nullable required
scriptIdstring uuid nullable required
source'schedule' | 'app' | 'agent' | 'null' nullable required
startedAtstring date-time required
status'running' | 'completed' | 'partial' | 'failed' | 'skipped' required

Changes

No recorded changes to this operation across all 1 revision of this API.