Sign in
latestOpenAPI 3.0.12026-08-10434791.3 KB

4eedf1838ef4

Schedule

Backfill sessions for past schedule times

post/api/schedules/{id}/backfill

Path parameters

idinteger required

session id

Request body

advanceScheduleboolean

If true, advance nextScheduleTime/nextRunTime. When fromTime is not set, uses the current schedule's nextRunTime as starting point. Requires skipExisting to be true.

attemptNamestring

attempt name. Optional when skipExisting is true. Cannot be specified when advanceSchedule is true.

countinteger

starts given number of sessions. run all sessions if not set.

dryRunboolean required

dry run

fromTimestring date-time

backfill from

skipExistingboolean

If true, silently skip sessions that already have attempts instead of returning 409 conflict error. Note that when count is set, skipped sessions are still counted towards the count.

Example request

{
  "fromTime": "2023-08-18T06:52:33Z"
}

Response

default response

idstring required

schedule ID

Example response

{
  "attempts": [
    {
      "createdAt": "2023-08-18T06:52:33Z",
      "finishedAt": "2023-08-18T06:52:33Z",
      "id": "123456",
      "index": 1,
      "poolId": "42",
      "project": {
        "id": "123456",
        "name": "abcdefg"
      },
      "retryAttemptName": "retry-12345",
      "sessionId": "123456",
      "sessionTime": "2022-12-31T23:59:00+00:00",
      "sessionUuid": "2b91a014-076e-4c6d-8b51-f4f91089cab2",
      "status": "running",
      "workflow": {
        "id": "123456",
        "name": "abcdefg"
      }
    }
  ],
  "id": "123456",
  "project": {
    "id": "123456",
    "name": "abcdefg"
  },
  "workflow": {
    "id": "123456",
    "name": "abcdefg"
  }
}