mirror of
https://github.com/jmagar/unraid-mcp.git
synced 2026-03-25 21:34:12 -07:00
183db70d97
Resolves review threads: - PRRT_kwDOO6Hdxs50mcYz: oidc/validate_session now documents required `token` - PRRT_kwDOO6Hdxs50mcY8: setting/update corrected to require `settings_input` - PRRT_kwDOO6Hdxs50mcZE: rclone/create_remote corrected to `provider_type`+`config_data` - PRRT_kwDOO6Hdxs50mcZL: disk/logs corrected to `log_path`+`tail_lines` - PRRT_kwDOO6Hdxs50mcZe: parity_progress added to event-driven subscriptions list - PRRT_kwDOO6Hdxs50mcZh: log_tail README example now includes required `path` - PRRT_kwDOO6Hdxs50mcaR: parity_start quick-reference now includes required `correct=False` - PRRT_kwDOO6Hdxs50mcaq: array_state documented as "may show" not "will always show" - PRRT_kwDOO6Hdxs50mnR8: key/create roles is optional; add_role/remove_role use `roles` (plural) - PRRT_kwDOO6Hdxs50mnRd: endpoints.md heading moved before blockquote (MD041) - PRRT_kwDOO6Hdxs50mnTB: test_resources.py uses _get_resource() helper instead of raw internals - PRRT_kwDOO6Hdxs50mYkZ: N/A — _build_google_auth removed in prior refactor commit - PRRT_kwDOO6Hdxs50mnQf: N/A — plugin.json already at 1.1.2, matches pyproject.toml - PRRT_kwDOO6Hdxs50mnQ7: N/A — blank line already present in CLAUDE.md - PRRT_kwDOO6Hdxs50mnRD: N/A — fastmcp.http.json removed in prior refactor commit - PRRT_kwDOO6Hdxs50mnRH: N/A — blank line already present in README.md - PRRT_kwDOO6Hdxs50mnSW: N/A — test_auth_builder.py removed in prior refactor commit
52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
# Unraid API Endpoints Reference
|
|
|
|
> **⚠️ DEVELOPER REFERENCE ONLY** — This file documents raw GraphQL endpoints for development purposes. For MCP tool usage, use `unraid(action=..., subaction=...)` calls as documented in `SKILL.md`.
|
|
|
|
Complete list of available GraphQL read-only endpoints in Unraid 7.2+.
|
|
|
|
## System & Metrics (8)
|
|
1. **`info`** - Hardware specs (CPU, OS, motherboard)
|
|
2. **`metrics`** - Real-time CPU/memory usage
|
|
3. **`online`** - Server online status
|
|
4. **`isInitialSetup`** - Setup completion status
|
|
5. **`config`** - System configuration
|
|
6. **`vars`** - System variables
|
|
7. **`settings`** - System settings
|
|
8. **`logFiles`** - List all log files
|
|
|
|
## Storage (4)
|
|
9. **`array`** - Array status, disks, parity
|
|
10. **`disks`** - All physical disks (array + cache + USB)
|
|
11. **`shares`** - Network shares
|
|
12. **`logFile`** - Read log content
|
|
|
|
## Virtualization (2)
|
|
13. **`docker`** - Docker containers
|
|
14. **`vms`** - Virtual machines
|
|
|
|
## Monitoring (2)
|
|
15. **`notifications`** - System alerts
|
|
16. **`upsDevices`** - UPS battery status
|
|
|
|
## User & Auth (4)
|
|
17. **`me`** - Current user info
|
|
18. **`owner`** - Server owner
|
|
19. **`isSSOEnabled`** - SSO status
|
|
20. **`oidcProviders`** - OIDC providers
|
|
|
|
## API Management (1)
|
|
21. **`apiKeys`** - List API keys
|
|
|
|
## Customization (3)
|
|
22. **`customization`** - UI theme & settings
|
|
23. **`publicTheme`** - Public theme
|
|
24. **`publicPartnerInfo`** - Partner branding
|
|
|
|
## Server Management (3)
|
|
25. **`registration`** - License info
|
|
26. **`server`** - Server metadata
|
|
27. **`servers`** - Multi-server management
|
|
|
|
## Bonus (1)
|
|
28. **`plugins`** - Installed plugins (returns empty array if none)
|