Schedules

Operations related to schedules. Schedules allow you to automatically start or stop a live stream or transcoder at a predetermined date and time. You can configure a schedule to start and/or stop a live stream or transcoder just once, or you can configure it to repeat the behavior on a regular basis. See About schedules to learn more.

Create a schedule

This operation creates a schedule.

Request

Request Body schema: application/json
required

Provide the details of the schedule to create in the body of the request.

required

object (schedule)

action_type required	string The type of action that the schedule should trigger on the transcoder. The default is start. Enum: "start" "stop" "start_stop"
name required	string A descriptive name for the schedule. Maximum 255 characters.
recurrence_type required	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"
transcoder_id required	string The unique alphanumeric string that identifies the transcoder being scheduled.
end_repeat	string <date> 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"`
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"
start_repeat	string <date> 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"`
start_transcoder	string <date-time> 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"`
stop_transcoder	string <date-time> 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"`

Responses

201

Success

Response Schema: application/json

required

object (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"
created_at	string <date-time> The date and time that the schedule was created.
end_repeat	string <date> The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD.
id	string The unique alphanumeric string that identifies the schedule.
name	string A descriptive name for the schedule. Maximum 255 characters.
recurrence_data	string The day or days of the week that a recurring schedule should run. Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"
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"
start_repeat	string <date> The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD.
start_transcoder	string <date-time> 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.
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"
stop_transcoder	string <date-time> 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.
transcoder_id	string The unique alphanumeric string that identifies the transcoder being scheduled.
transcoder_name	string The name of the transcoder being scheduled.
updated_at	string <date-time> The date and time that the schedule was updated.

401

Unauthorized

422

Unprocessable Entity

post/schedules

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"schedule": {"action_type": "start_stop",
"name": "Scheduled start for my camera",
"recurrence_type": "recur",
"transcoder_id": "km1FSSVL",
"end_repeat": "2020-02-29T00:00:00.000Z",
"recurrence_data": "monday,tuesday,wednesday,thursday,friday",
"start_repeat": "2020-02-01T00:00:00.000Z",
"start_transcoder": "2020-02-01T00:00:00.000Z",
"stop_transcoder": "2020-02-29T23:59:59.999Z"
}
}

Response samples

application/json

{"schedule": {"action_type": "start_stop",
"begins_at": "2020-02-01T00:00:00.000Z",
"created_at": "2020-01-29T17:16:21.995Z",
"end_repeat": "2020-02-29T00:00:00.000Z",
"ends_at": "2020-02-29T23:59:59.999Z",
"id": "28bwb5WT",
"name": "Scheduled recurring start for my camera",
"recurrence_data": "monday,tuesday,wednesday,thursday,friday",
"recurrence_type": "recur",
"start_repeat": "2020-02-01T00:00:00.000Z",
"state": "disabled",
"transcoder_id": "VGB21JFJ",
"transcoder_name": "My Camera",
"updated_at": "2020-01-31T07:00:48.995Z"
}
}

Fetch all schedules

This operation shows the details of all of your schedules.

Request

query Parameters

filter	string Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index. For valid filter operators and filter fields, see How to get filtered query results with the Wowza Video REST API. Example: filter[0][field]=state&filter[0][eq]=stopped
page	integer Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1. For more information and examples, see Get paginated query results with the Wowza Video REST API.
per_page	integer For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses

200

Success

Response Schema: application/json

required

Array of objects (schedule)

Array

action_type	string The type of action that the schedule should trigger on the transcoder. The default is start. Enum: "start" "stop" "start_stop"
created_at	string <date-time> The date and time that the schedule was created.
end_repeat	string <date> The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD.
id	string The unique alphanumeric string that identifies the schedule.
name	string A descriptive name for the schedule. Maximum 255 characters.
recurrence_data	string The day or days of the week that a recurring schedule should run. Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"
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"
start_repeat	string <date> The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD.
start_transcoder	string <date-time> 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.
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"
stop_transcoder	string <date-time> 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.
transcoder_id	string The unique alphanumeric string that identifies the transcoder being scheduled.
transcoder_name	string The name of the transcoder being scheduled.
updated_at	string <date-time> The date and time that the schedule was updated.

401

Unauthorized

get/schedules

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.10/schedules"

Response samples

application/json

{"schedules": [{"action_type": "start_stop",
"begins_at": "2020-02-01T00:00:00.000Z",
"created_at": "2020-01-29T17:16:21.995Z",
"end_repeat": "2020-02-29T00:00:00.000Z",
"ends_at": "2020-02-29T23:59:59.999Z",
"id": "28bwb5WT",
"name": "Scheduled recurring start for my camera",
"recurrence_data": "monday,tuesday,wednesday,thursday,friday",
"recurrence_type": "recur",
"start_repeat": "2020-02-01T00:00:00.000Z",
"state": "disabled",
"transcoder_id": "VGB21JFJ",
"transcoder_name": "My Camera",
"updated_at": "2020-01-31T14:58:43.995Z"
},
{"action_type": "stop",
"begins_at": "2020-02-01T00:00:00.000Z",
"created_at": "2020-01-29T17:16:21.995Z",
"ends_at": "2020-02-29T23:59:59.999Z",
"id": "4RCWgfS5",
"name": "Scheduled stop for my live event",
"recurrence_type": "once",
"state": "enabled",
"transcoder_id": "Qjl5J38Z",
"transcoder_name": "Awesome Live Event",
"updated_at": "2020-01-31T08:25:45.995Z"
}
]
}

Fetch a schedule

This operation shows the details of a specific schedule.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the schedule.

Responses

200

Success

Response Schema: application/json

required

object (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"
created_at	string <date-time> The date and time that the schedule was created.
end_repeat	string <date> The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD.
id	string The unique alphanumeric string that identifies the schedule.
name	string A descriptive name for the schedule. Maximum 255 characters.
recurrence_data	string The day or days of the week that a recurring schedule should run. Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"
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"
start_repeat	string <date> The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD.
start_transcoder	string <date-time> 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.
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"
stop_transcoder	string <date-time> 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.
transcoder_id	string The unique alphanumeric string that identifies the transcoder being scheduled.
transcoder_name	string The name of the transcoder being scheduled.
updated_at	string <date-time> The date and time that the schedule was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/schedules/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.10/schedules/2adffc17"

Response samples

application/json

{"schedule": {"action_type": "start_stop",
"begins_at": "2020-02-01T00:00:00.000Z",
"created_at": "2020-01-29T17:16:21.995Z",
"end_repeat": "2020-02-29T00:00:00.000Z",
"ends_at": "2020-02-29T23:59:59.999Z",
"id": "28bwb5WT",
"name": "Scheduled recurring start for my camera",
"recurrence_data": "monday,tuesday,wednesday,thursday,friday",
"recurrence_type": "recur",
"start_repeat": "2020-02-01T00:00:00.000Z",
"state": "disabled",
"transcoder_id": "VGB21JFJ",
"transcoder_name": "My Camera",
"updated_at": "2020-01-31T07:00:48.995Z"
}
}

Update a schedule

This operation updates a schedule.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the schedule.

Request Body schema: application/json
required

Provide the details of the schedule to update in the body of the request.

required

object (schedule)

action_type	string The type of action that the schedule should trigger on the transcoder. The default is start. Example: `"action_type": "stop"` Enum: "start" "stop" "start_stop"
name	string A descriptive name for the schedule. Maximum 255 characters. Example: `"name": "My Updated Schedule"`
end_repeat	string <date> 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"`
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"
start_repeat	string <date> 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"`
start_transcoder	string <date-time> 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: `"start_transcoder": "2020-02-01T00:00:00.000Z"`
stop_transcoder	string <date-time> 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: `"start_transcoder": "2020-02-29T23:59:59.999Z"`

Responses

200

Success

Response Schema: application/json

required

object (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"
created_at	string <date-time> The date and time that the schedule was created.
end_repeat	string <date> The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD.
id	string The unique alphanumeric string that identifies the schedule.
name	string A descriptive name for the schedule. Maximum 255 characters.
recurrence_data	string The day or days of the week that a recurring schedule should run. Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"
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"
start_repeat	string <date> The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD.
start_transcoder	string <date-time> 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.
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"
stop_transcoder	string <date-time> 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.
transcoder_id	string The unique alphanumeric string that identifies the transcoder being scheduled.
transcoder_name	string The name of the transcoder being scheduled.
updated_at	string <date-time> The date and time that the schedule was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/schedules/{id}

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"schedule": {"action_type": "start_stop",
"name": "Scheduled start for my camera",
"end_repeat": "2020-02-29T00:00:00.000Z",
"recurrence_data": "monday,tuesday,wednesday,thursday,friday",
"start_repeat": "2020-02-01T00:00:00.000Z",
"start_transcoder": "2020-02-01T00:00:00.000Z",
"stop_transcoder": "2020-02-29T23:59:59.999Z"
}
}

Response samples

application/json

{"schedule": {"action_type": "start_stop",
"begins_at": "2020-02-01T00:00:00.000Z",
"created_at": "2020-01-29T17:16:21.995Z",
"end_repeat": "2020-02-29T00:00:00.000Z",
"ends_at": "2020-02-29T23:59:59.999Z",
"id": "28bwb5WT",
"name": "Scheduled recurring start for my camera",
"recurrence_data": "monday,tuesday,wednesday,thursday,friday",
"recurrence_type": "recur",
"start_repeat": "2020-02-01T00:00:00.000Z",
"state": "disabled",
"transcoder_id": "VGB21JFJ",
"transcoder_name": "My Camera",
"updated_at": "2020-01-31T07:00:48.995Z"
}
}

Delete a schedule

This operation deletes a schedule.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the schedule.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/schedules/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v1.10/schedules/2adffc17"

Response samples

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

Enable a schedule

This operation enables a schedule.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the schedule.

Responses

200

Success

Response Schema: application/json

required

object (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"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/schedules/{id}/enable

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.10/schedules/2adffc17/enable"

Response samples

application/json

{"schedule": {"state": "enabled"
}
}

Disable a schedule

This operation disables a schedule.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the schedule.

Responses

200

Success

Response Schema: application/json

required

object (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"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/schedules/{id}/disable

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.10/schedules/2adffc17/disable"

Response samples

application/json

{"schedule": {"state": "disabled"
}
}

Fetch the state of a schedule

This operation shows the current state of a schedule.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the schedule.

Responses

200

Success

Response Schema: application/json

required

object (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"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/schedules/{id}/state

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.10/schedules/2adffc17/state"

Response samples

application/json

{"schedule": {"state": "enabled"
}
}

Schedules

Create a schedule

Request Body schema: application/jsonrequired

Response Schema: application/json

Fetch all schedules

query Parameters

Response Schema: application/json

Fetch a schedule

path Parameters

Response Schema: application/json

Update a schedule

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Delete a schedule

path Parameters

Enable a schedule

path Parameters

Response Schema: application/json

Disable a schedule

path Parameters

Response Schema: application/json

Fetch the state of a schedule

path Parameters

Response Schema: application/json

Request Body schema: application/json
required

Request Body schema: application/json
required