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

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
application/json
{
  • "schedule": {
    }
}
Response samples
application/json
{
  • "schedule": {
    }
}

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
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/schedules"
Response samples
application/json
{
  • "schedules": [
    ]
}

Fetch a schedule

This operation shows the details of a specific schedule.

Request
path Parameters
id
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
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/schedules/2adffc17"
Response samples
application/json
{
  • "schedule": {
    }
}

Update a schedule

This operation updates a schedule.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the schedule.

Request Body schema: application/json

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
application/json
{
  • "schedule": {
    }
}
Response samples
application/json
{
  • "schedule": {
    }
}

Delete a schedule

This operation deletes a schedule.

Request
path Parameters
id
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
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v1.9/schedules/2adffc17"
Response samples
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    },
  • "Example Response 8": {
    },
  • "Example Response 9": {
    }
}

Enable a schedule

This operation enables a schedule.

Request
path Parameters
id
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
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.9/schedules/2adffc17/enable"
Response samples
application/json
{
  • "schedule": {
    }
}

Disable a schedule

This operation disables a schedule.

Request
path Parameters
id
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
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.9/schedules/2adffc17/disable"
Response samples
application/json
{
  • "schedule": {
    }
}

Fetch the state of a schedule

This operation shows the current state of a schedule.

Request
path Parameters
id
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
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/schedules/2adffc17/state"
Response samples
application/json
{
  • "schedule": {
    }
}
Copyright © Wowza Video. All right reserved.