FIfiles
schedules
Schedules

Create Schedule

Changed on

Create Schedule

post/schedules

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/schedules
  • Auth
    none declared

Request body multipart/form-data

namestring required

Schedule name.

schedule_days_of_weekinteger[] required

0-based weekdays used by the Schedule. 0 is Sunday.

schedule_times_of_daystring[] required

Times of day in HH:MM format (24-hour).

schedule_time_zonestring

Time zone for scheduled times. If not set, times are interpreted as UTC.

holiday_regionstring

Optional holiday region on which linked resources do not run.

Example request

{
  "name": "Weekday overnight",
  "schedule_days_of_week": [
    1,
    2,
    3,
    4,
    5
  ],
  "schedule_times_of_day": [
    "01:00"
  ],
  "schedule_time_zone": "Eastern Time (US & Canada)",
  "holiday_region": "us"
}

Response

The Schedules object.

idinteger

Schedule ID.

namestring

Schedule name.

schedule_days_of_weekinteger[]

0-based weekdays used by the Schedule. 0 is Sunday.

schedule_times_of_daystring[]

Times of day in HH:MM format (24-hour).

schedule_time_zonestring

Time zone for scheduled times. If not set, times are interpreted as UTC.

holiday_regionstring

Optional holiday region on which linked resources do not run.

human_readable_schedulestring

Human-readable Schedule description.

created_atstring date-time

Creation time.

updated_atstring date-time

Last update time.

Example response

{
  "id": 1,
  "name": "Weekday overnight",
  "schedule_days_of_week": [
    1,
    2,
    3,
    4,
    5
  ],
  "schedule_times_of_day": [
    "01:00"
  ],
  "schedule_time_zone": "Eastern Time (US & Canada)",
  "holiday_region": "us",
  "human_readable_schedule": "Triggered every Monday, Tuesday, Wednesday, Thursday, Friday at 01:00 AM UTC TZ.",
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}

Changes