Skip to content

Schedules

Retrieve the valid schedule options supported by the Smoketest API.

View as Markdown

List schedule options

Returns the set of values accepted for each scheduling dimension. Use this endpoint to populate scheduling UIs or to validate schedule configuration before creating or updating a test. Requires the read scope.

GEThttps://api.smoketest.sh/v1/schedules/optionsscope: read
Shell
curl https://api.smoketest.sh/v1/schedules/options \
  -H "Authorization: Bearer $SMOKETEST_API_KEY"

Sample response

JSON
{
  "hourly": [1, 3, 6, 12],
  "dailyHours": [0, 6, 9, 12, 15, 18, 22],
  "weekDays": [0, 1, 2, 3, 4, 5, 6]
}
FieldTypeDescription
hourlyinteger[]Supported every-N-hours cadences for hourly schedules
dailyHoursinteger[]UTC hours at which daily schedules can be set to fire (0 = midnight)
weekDaysinteger[]Day-of-week values for weekly schedules (0 = Sunday, 6 = Saturday)

When creating or updating a test with trigger = "schedule", the schedule field must encode one of these supported combinations. See Scheduling for the full schedule format reference.

On this page