Zum Hauptinhalt springen

Willkommen zur Unraid API

What's Neu

Ab Unraid OS v7.2 ist die API direkt in das Betriebssystem integriert - keine Plugin-Installation erforderlich!

Die Unraid-API bietet eine GraphQL-Schnittstelle für die programmatische Interaktion mit Ihrem Unraid-Server. Sie ermöglicht Automatisierung, Überwachung und Integrationsmöglichkeiten.

📦 Verfügbarkeit​

✨ Native Integration (Unraid OS v7.2+)​

Ab Unraid OS v7.2 ist die API direkt in das Betriebssystem integriert:

  • Keine Plugin-Installation erforderlich
  • Automatisch verfügbar beim Systemstart
  • Tiefgehende Systemintegration
  • Zugriff über Einstellungen → Managementzugang → API

🔌 Plugin-Installation (Vor Version 7.2 und fortgeschrittene Benutzer)​

Für Unraid-Versionen vor v7.2 oder um neuere API-Funktionen zu nutzen:

  1. Installiere das Unraid Connect Plugin aus den Community Apps
  2. Konfiguriere das Plugin
  3. Zugriff auf API-Funktionalität über den GraphQL Sandbox
Important Anmerkungen
  • Das Unraid Connect Plugin stellt die API für Versionen vor 7.2 bereit
  • Anmeldung bei Unraid Connect ist NICHT erforderlich, um die API lokal zu nutzen
  • Durch Installation des Plugins auf 7.2+ erhalten Sie Zugriff auf neuere API-Funktionen, bevor sie in OS-Releases enthalten sind

📚 Dokumentationsabschnitte​

Vollständige Referenz für alle CLI-Befehle

Lernen, wie man mit der GraphQL-API interagiert

SSO-Authentifizierungsanbieter konfigurieren

Sieh, was als Nächstes kommt

🌟 Wichtige Funktionen​

Core Fähigkeiten

Die API stellt bereit:

  • GraphQL-Schnittstelle: Moderne, flexible API mit starker Typisierung
  • Authentifizierung: Verschiedene Methoden inklusive API-Schlüssel, Sitzungs-Cookies und SSO/OIDC
  • Umfassende Abdeckung: Zugriff auf Systeminformationen, Array-Verwaltung und Docker-Operationen
  • Entwicklerwerkzeuge: Eingebauter GraphQL-Sandbox, konfigurierbar über Webschnittstelle oder CLI
  • Rollenbasierte Zugänge: Granulare Berechtigungskontrolle
  • Web-Management: API-Schlüssel und Einstellungen über die Webschnittstelle verwalten

🚀 Loslegen​

  1. Die API ist bereits installiert und läuft
  2. Zugriffseinstellungen unter Einstellungen → Managementzugang → API
  3. Aktiviere die GraphQL-Sandbox für die Entwicklung
  4. Erstelle deinen ersten API-Schlüssel
  5. Beginne mit GraphQL-Abfragen!

Für detaillierte Nutzungsanweisungen siehe die CLI-Befehle Referenz.