bookshelf_system_commands
Execute system commands on Bookshelf to manage health, status, routes, tasks, backups, restart, shutdown, and run custom commands.
Instructions
bookshelf system commands operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters.
bookshelf_delete_command(id) — Delete command. DESTRUCTIVE: this deletes data.
bookshelf_delete_system_backup(id) — Delete system backup. DESTRUCTIVE: this deletes data.
bookshelf_get_command(id) — Fetch a single command by id.
bookshelf_get_health() — List health.
bookshelf_get_system_routes() — List system routes.
bookshelf_get_system_routes_duplicate() — List system routes duplicate.
bookshelf_get_system_status() — Get system status: app name, version, OS, build, and runtime.
bookshelf_get_system_task() — List system task.
bookshelf_get_system_task_by_id(id) — Fetch a single system task by id.
bookshelf_list_command() — List command.
bookshelf_list_log(page=1, page_size=10, sort_key=None, sort_direction=None, level=None) — List log. Query params: page, pageSize, sortKey, sortDirection, level.
bookshelf_list_log_file() — List log file.
bookshelf_list_log_file_update() — List log file update.
bookshelf_list_system_backup() — List system backup.
bookshelf_ping() — List ping.
bookshelf_restart() — Restart the Bookshelf service.
bookshelf_restore_backup(id) — Create system backup restore. WRITE: this modifies your Bookshelf instance.
bookshelf_restore_backup_upload() — Create system backup restore upload. WRITE: this modifies your Bookshelf instance.
bookshelf_run_command(body={}) — Run a Bookshelf command (body is a CommandResource with a
name, e.g. RefreshAuthor, AuthorSearch, BookSearch, DownloadedBooksScan, RenamedBookFiles, RescanFolders, MetadataRefresh). WRITE: this modifies your Bookshelf instance.bookshelf_shutdown() — Shut down the Bookshelf service.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| arguments | No | ||
| operation | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |