(Butler)
Butler is the task manager of the Plex Media Server Ecosystem.
- GetButlerTasks - Get Butler tasks
- StartAllTasks - Start all Butler tasks
- StopAllTasks - Stop all Butler tasks
- StartTask - Start a single Butler task
- StopTask - Stop a single Butler task
Returns a list of butler tasks
package main
import(
"github.com/LukeHagar/plexgo"
"context"
"log"
)
func main() {
s := plexgo.New(
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
plexgo.WithXPlexClientIdentifier("Postman"),
)
ctx := context.Background()
res, err := s.Butler.GetButlerTasks(ctx)
if err != nil {
log.Fatal(err)
}
if res.Object != nil {
// handle response
}
}
Parameter | Type | Required | Description |
---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
*operations.GetButlerTasksResponse, error
Error Object | Status Code | Content Type |
---|---|---|
sdkerrors.GetButlerTasksResponseBody | 401 | application/json |
sdkerrors.SDKError | 4xx-5xx | / |
This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
- Any tasks not scheduled to run on the current day will be skipped.
- If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
- If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
- If we are outside the configured window, the task will start immediately.
package main
import(
"github.com/LukeHagar/plexgo"
"context"
"log"
)
func main() {
s := plexgo.New(
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
plexgo.WithXPlexClientIdentifier("Postman"),
)
ctx := context.Background()
res, err := s.Butler.StartAllTasks(ctx)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
Parameter | Type | Required | Description |
---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
*operations.StartAllTasksResponse, error
Error Object | Status Code | Content Type |
---|---|---|
sdkerrors.StartAllTasksResponseBody | 401 | application/json |
sdkerrors.SDKError | 4xx-5xx | / |
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
package main
import(
"github.com/LukeHagar/plexgo"
"context"
"log"
)
func main() {
s := plexgo.New(
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
plexgo.WithXPlexClientIdentifier("Postman"),
)
ctx := context.Background()
res, err := s.Butler.StopAllTasks(ctx)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
Parameter | Type | Required | Description |
---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
*operations.StopAllTasksResponse, error
Error Object | Status Code | Content Type |
---|---|---|
sdkerrors.StopAllTasksResponseBody | 401 | application/json |
sdkerrors.SDKError | 4xx-5xx | / |
This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
- Any tasks not scheduled to run on the current day will be skipped.
- If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
- If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
- If we are outside the configured window, the task will start immediately.
package main
import(
"github.com/LukeHagar/plexgo"
"github.com/LukeHagar/plexgo/models/operations"
"context"
"log"
)
func main() {
s := plexgo.New(
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
plexgo.WithXPlexClientIdentifier("Postman"),
)
var taskName operations.TaskName = operations.TaskNameCleanOldBundles
ctx := context.Background()
res, err := s.Butler.StartTask(ctx, taskName)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
Parameter | Type | Required | Description |
---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
taskName |
operations.TaskName | ✔️ | the name of the task to be started. |
*operations.StartTaskResponse, error
Error Object | Status Code | Content Type |
---|---|---|
sdkerrors.StartTaskResponseBody | 401 | application/json |
sdkerrors.SDKError | 4xx-5xx | / |
This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
package main
import(
"github.com/LukeHagar/plexgo"
"github.com/LukeHagar/plexgo/models/operations"
"context"
"log"
)
func main() {
s := plexgo.New(
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
plexgo.WithXPlexClientIdentifier("Postman"),
)
var taskName operations.PathParamTaskName = operations.PathParamTaskNameBackupDatabase
ctx := context.Background()
res, err := s.Butler.StopTask(ctx, taskName)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
Parameter | Type | Required | Description |
---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
taskName |
operations.PathParamTaskName | ✔️ | The name of the task to be started. |
*operations.StopTaskResponse, error
Error Object | Status Code | Content Type |
---|---|---|
sdkerrors.StopTaskResponseBody | 401 | application/json |
sdkerrors.SDKError | 4xx-5xx | / |