# Create a schedule This operation creates a schedule. Endpoint: POST /schedules Version: v2.0 ## Request fields (application/json): - `schedule` (object, required) - `schedule.action_type` (string, required) The type of action that the schedule should trigger on the transcoder. The default is start. Enum: "start", "stop", "start_stop" - `schedule.name` (string, required) A descriptive name for the schedule. Maximum 255 characters. Example: "Scheduled start for my camera" - `schedule.recurrence_type` (string, required) A schedule can run one time only (once) or repeat (recur) until a specified end_repeat date. The default is once. Enum: "once", "recur" - `schedule.time_zone` (string) The time zone the schedule runs in. Click to expand for the full list of valid values | Locations | Wowza Video time_zone value | |---|---| | International Date Line West | Etc/GMT+12 | | Midway Island | Pacific/Midway | | American Samoa | Pacific/Pago_Pago | | Hawaii | Pacific/Honolulu | | Alaska | America/Juneau | | Pacific Time (US & Canada) | America/Los_Angeles | | Tijuana | America/Tijuana | | Mountain Time (US & Canada) | America/Denver | | Arizona | America/Phoenix | | Chihuahua | America/Chihuahua | | Mazatlan | America/Mazatlan | | Central Time (US & Canada) | America/Chicago | | Saskatchewan | America/Regina | | Guadalajara | America/Mexico_City | | Mexico City | America/Mexico_City | | Monterrey | America/Monterrey | | Central America | America/Guatemala | | Eastern Time (US & Canada) | America/New_York | | Indiana (East) | America/Indiana/Indianapolis | | Bogota | America/Bogota | | Lima | America/Lima | | Quito | America/Lima | | Atlantic Time (Canada) | America/Halifax | | Caracas | America/Caracas | | La Paz | America/La_Paz | | Santiago | America/Santiago | | Newfoundland | America/St_Johns | | Brasilia | America/Sao_Paulo | | Buenos Aires | America/Argentina/Buenos_Aires | | Montevideo | America/Montevideo | | Georgetown | America/Guyana | | Puerto Rico | America/Puerto_Rico | | Greenland | America/Godthab | | Mid-Atlantic | Atlantic/South_Georgia | | Azores | Atlantic/Azores | | Cape Verde Is. | Atlantic/Cape_Verde | | Dublin | Europe/Dublin | | Edinburgh | Europe/London | | Lisbon | Europe/Lisbon | | London | Europe/London | | Casablanca | Africa/Casablanca | | Monrovia | Africa/Monrovia | | UTC | Etc/UTC | | Belgrade | Europe/Belgrade | | Bratislava | Europe/Bratislava | | Budapest | Europe/Budapest | | Ljubljana | Europe/Ljubljana | | Prague | Europe/Prague | | Sarajevo | Europe/Sarajevo | | Skopje | Europe/Skopje | | Warsaw | Europe/Warsaw | | Zagreb | Europe/Zagreb | | Brussels | Europe/Brussels | | Copenhagen | Europe/Copenhagen | | Madrid | Europe/Madrid | | Paris | Europe/Paris | | Amsterdam | Europe/Amsterdam | | Berlin | Europe/Berlin | | Bern | Europe/Zurich | | Zurich | Europe/Zurich | | Rome | Europe/Rome | | Stockholm | Europe/Stockholm | | Vienna | Europe/Vienna | | West Central Africa | Africa/Algiers | | Bucharest | Europe/Bucharest | | Cairo | Africa/Cairo | | Helsinki | Europe/Helsinki | | Kyiv | Europe/Kiev | | Riga | Europe/Riga | | Sofia | Europe/Sofia | | Tallinn | Europe/Tallinn | | Vilnius | Europe/Vilnius | | Athens | Europe/Athens | | Istanbul | Europe/Istanbul | | Minsk | Europe/Minsk | | Jerusalem | Asia/Jerusalem | | Harare | Africa/Harare | | Pretoria | Africa/Johannesburg | | Kaliningrad | Europe/Kaliningrad | | Moscow | Europe/Moscow | | St. Petersburg | Europe/Moscow | | Volgograd | Europe/Volgograd | | Samara | Europe/Samara | | Kuwait | Asia/Kuwait | | Riyadh | Asia/Riyadh | | Nairobi | Africa/Nairobi | | Baghdad | Asia/Baghdad | | Tehran | Asia/Tehran | | Abu Dhabi | Asia/Muscat | | Muscat | Asia/Muscat | | Baku | Asia/Baku | | Tbilisi | Asia/Tbilisi | | Yerevan | Asia/Yerevan | | Kabul | Asia/Kabul | | Ekaterinburg | Asia/Yekaterinburg | | Islamabad | Asia/Karachi | | Karachi | Asia/Karachi | | Tashkent | Asia/Tashkent | | Chennai | Asia/Kolkata | | Kolkata | Asia/Kolkata | | Mumbai | Asia/Kolkata | | New Delhi | Asia/Kolkata | | Kathmandu | Asia/Kathmandu | | Astana | Asia/Dhaka | | Dhaka | Asia/Dhaka | | Sri Jayawardenepura | Asia/Colombo | | Almaty | Asia/Almaty | | Novosibirsk | Asia/Novosibirsk | | Rangoon | Asia/Rangoon | | Bangkok | Asia/Bangkok | | Hanoi | Asia/Bangkok | | Jakarta | Asia/Jakarta | | Krasnoyarsk | Asia/Krasnoyarsk | | Beijing | Asia/Shanghai | | Chongqing | Asia/Chongqing | | Hong Kong | Asia/Hong_Kong | | Urumqi | Asia/Urumqi | | Kuala Lumpur | Asia/Kuala_Lumpur | | Singapore | Asia/Singapore | | Taipei | Asia/Taipei | | Perth | Australia/Perth | | Irkutsk | Asia/Irkutsk | | Ulaanbaatar | Asia/Ulaanbaatar | | Seoul | Asia/Seoul | | Osaka | Asia/Tokyo | | Sapporo | Asia/Tokyo | | Tokyo | Asia/Tokyo | | Yakutsk | Asia/Yakutsk | | Darwin | Australia/Darwin | | Adelaide | Australia/Adelaide | | Canberra | Australia/Melbourne | | Melbourne | Australia/Melbourne | | Sydney | Australia/Sydney | | Brisbane | Australia/Brisbane | | Hobart | Australia/Hobart | | Vladivostok | Asia/Vladivostok | | Guam | Pacific/Guam | | Port Moresby | Pacific/Port_Moresby | | Magadan | Asia/Magadan | | Srednekolymsk | Asia/Srednekolymsk | | Solomon Is. | Pacific/Guadalcanal | | New Caledonia | Pacific/Noumea | | Fiji | Pacific/Fiji | | Kamchatka | Asia/Kamchatka | | Marshall Is. | Pacific/Majuro | | Auckland | Pacific/Auckland | | Wellington | Pacific/Auckland | | Nuku'alofa | Pacific/Tongatapu | | Tokelau Is. | Pacific/Fakaofo | | Chatham Is. | Pacific/Chatham | | Samoa | Pacific/Apia | Default: Etc/UTC Example: America/New_York Example: "America/New_York" - `schedule.transcoder_id` (string, required) The unique alphanumeric string that identifies the transcoder being scheduled. Example: "km1FSSVL" - `schedule.end_repeat` (string) The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD. Example: "end_repeat": "2020-02-29T00:00:00.000Z" Example: "2020-02-29T00:00:00.000Z" - `schedule.recurrence_data` (string) The day or days of the week that a recurring schedule should run. Example: "recurrence_data": "monday,tuesday,wednesday,thursday,friday" Enum: "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" - `schedule.start_repeat` (string) The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD. Example: "start_repeat": "2020-02-01T00:00:00.000Z" Example: "2020-02-01T00:00:00.000Z" - `schedule.start_transcoder` (string) The month, day, year, and time of day that the action_type start should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. Required when action_type is start or start_stop. Example: "start_transcoder": "2020-02-01T00:00:00.000Z" Example: "2020-02-01T00:00:00.000Z" - `schedule.stop_transcoder` (string) The month, day, year, and time of day that the action_type stop should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. Required when action_type is stop or start_stop. Example: "start_transcoder": "2020-02-29T23:59:59.999Z" Example: "2020-02-29T23:59:59.999Z" ## Response 201 fields (application/json): - `schedule` (object, required) Example: {"id":"28bwb5WT","state":"disabled","name":"Scheduled recurring start for my camera","time_zone":"America/New_York","transcoder_id":"VGB21JFJ","transcoder_name":"My Camera","recurrence_type":"recur","recurrence_data":"monday,tuesday,wednesday,thursday,friday","action_type":"start_stop","start_transcoder":"2020-02-01T00:00:00.000Z","stop_transcoder":"2020-02-29T23:59:59.999Z","start_repeat":"2020-02-01T00:00:00.000Z","end_repeat":"2020-02-29T00:00:00.000Z","created_at":"2020-01-29T17:16:21.995Z","updated_at":"2020-01-31T07:00:48.995Z"} - `schedule.action_type` (string) The type of action that the schedule should trigger on the transcoder. The default is start. Enum: "start", "stop", "start_stop" - `schedule.created_at` (string) The date and time that the schedule was created. Example: "2020-01-29T17:16:21.995Z" - `schedule.end_repeat` (string) The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD. Example: "2020-02-29T00:00:00.000Z" - `schedule.id` (string) The unique alphanumeric string that identifies the schedule. Example: "28bwb5WT" - `schedule.name` (string) A descriptive name for the schedule. Maximum 255 characters. Example: "Scheduled recurring start for my camera" - `schedule.recurrence_data` (string) The day or days of the week that a recurring schedule should run. Enum: "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" - `schedule.recurrence_type` (string) A schedule can run one time only (once) or repeat (recur) until a specified end_repeat date. The default is once. Enum: "once", "recur" - `schedule.start_repeat` (string) The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD. Example: "2020-02-01T00:00:00.000Z" - `schedule.start_transcoder` (string) The month, day, year, and time of day that the action_type start should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. Example: "2020-02-01T00:00:00.000Z" - `schedule.state` (string) A schedule must be enabled to run. Specify enabled to run the schedule or disabled to turn off the schedule so that it doesn't run. Enum: "enabled", "disabled", "expired" - `schedule.stop_transcoder` (string) The month, day, year, and time of day that the action_type stop should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. Example: "2020-02-29T23:59:59.999Z" - `schedule.time_zone` (string) The time zone the schedule runs in. Example: "America/New_York" - `schedule.transcoder_id` (string) The unique alphanumeric string that identifies the transcoder being scheduled. Example: "VGB21JFJ" - `schedule.transcoder_name` (string) The name of the transcoder being scheduled. Example: "My Camera" - `schedule.updated_at` (string) The date and time that the schedule was updated. Example: "2020-01-31T07:00:48.995Z" ## Response 401 fields (application/json): - `meta` (object, required) - `meta.status` (integer) - `meta.code` (string) - `meta.title` (string) - `meta.message` (string) - `meta.description` (string) - `meta.links` (array) ## Response 422 fields (application/json): - `meta` (object, required) - `meta.status` (integer) - `meta.code` (string) - `meta.title` (string) - `meta.message` (string) - `meta.description` (string) - `meta.links` (array)