Reference
API: Schedules
Schedules: List schedules, Create a schedule, Pause or resume a schedule, Delete a schedule.
List schedules
GET/api/v1/schedules
When tests run by themselves: every schedule in the workspace, or those of one test or project.
| Query |
|---|
testIdstring |
projectIdstring |
Returns { schedules: [{ id, testId, days, dayOfMonth, time, timezone, enabled, nextRunAt, lastRunAt, lastJobId, lastNote, text }] }
Request
curl https://app.testsy.dev/api/v1/schedules?testId=… \
-H "Authorization: Bearer $QA_AI_API_KEY"Create a schedule
POST/api/v1/tests/{testId}/schedules
Run a test by itself: on chosen weekdays, or monthly on a day, at a time in a time zone. Each scheduled run counts like any other run.
| Path |
|---|
testIdstringrequired |
| Body (JSON) |
|---|
daysstring[] |
dayOfMonthnumber |
timestringrequired |
timezonestring |
Returns 201 { id }
Request
curl -X POST https://app.testsy.dev/api/v1/tests/t_mvg0/schedules \
-H "Authorization: Bearer $QA_AI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"time":"02:00"}'Pause or resume a schedule
PATCH/api/v1/schedules/{scheduleId}
Pause or resume a schedule.
| Path |
|---|
scheduleIdstringrequired |
| Body (JSON) |
|---|
enabledbooleanrequired |
Returns { ok: true, enabled }
Request
curl -X PATCH https://app.testsy.dev/api/v1/schedules/s_7h \
-H "Authorization: Bearer $QA_AI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"enabled":false}'Delete a schedule
DELETE/api/v1/schedules/{scheduleId}
Delete a schedule.
| Path |
|---|
scheduleIdstringrequired |
Returns { ok: true }
Request
curl -X DELETE https://app.testsy.dev/api/v1/schedules/s_7h \
-H "Authorization: Bearer $QA_AI_API_KEY"