{
  "opencollection": "1.0.0",
  "info": {
    "name": "Plex Media Server Butler API",
    "version": "1.2.2\n"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Plex-Token",
      "value": "{{X-Plex-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Butler",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all Butler tasks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{IP-description}.{identifier}.plex.direct:{port}/butler",
            "auth": {
              "type": "apikey",
              "key": "X-Plex-Token",
              "value": "{{X-Plex-Token}}",
              "placement": "header"
            }
          },
          "docs": "Get the list of butler tasks and their scheduling\n"
        },
        {
          "info": {
            "name": "Start all Butler tasks",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{IP-description}.{identifier}.plex.direct:{port}/butler",
            "auth": {
              "type": "apikey",
              "key": "X-Plex-Token",
              "value": "{{X-Plex-Token}}",
              "placement": "header"
            }
          },
          "docs": "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:\n\n  1. Any tasks not scheduled to run on the current day will be skipped.\n  2. 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"
        },
        {
          "info": {
            "name": "Stop all Butler tasks",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{IP-description}.{identifier}.plex.direct:{port}/butler",
            "auth": {
              "type": "apikey",
              "key": "X-Plex-Token",
              "value": "{{X-Plex-Token}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue."
        },
        {
          "info": {
            "name": "Start a single Butler task",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{IP-description}.{identifier}.plex.direct:{port}/butler/:task",
            "params": [
              {
                "name": "task",
                "value": "",
                "type": "path",
                "description": "The task name"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Plex-Token",
              "value": "{{X-Plex-Token}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint will attempt to start a specific Butler task by name.\n"
        },
        {
          "info": {
            "name": "Stop a single Butler task",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{IP-description}.{identifier}.plex.direct:{port}/butler/:task",
            "params": [
              {
                "name": "task",
                "value": "",
                "type": "path",
                "description": "The task name"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Plex-Token",
              "value": "{{X-Plex-Token}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists\n"
        }
      ]
    }
  ],
  "bundled": true
}