Zum Hauptinhalt springen

Willkommen zur Unraid API

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

The Unraid API provides a GraphQL interface for programmatic interaction with your Unraid server. It enables automation, monitoring, and integration capabilities through a modern, strongly-typed API with multiple authentication methods (API keys, session cookies, and SSO/OIDC), comprehensive system coverage, and built-in developer tools.

Verfügbarkeit

Native Integration (Unraid 7.2+)

Ab Unraid 7.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 7.2 und für fortgeschrittene Benutzer)

Für Unraid-Versionen vor 7.2 oder um auf neuere API-Funktionen zuzugreifen:

  1. Installiere das Unraid Connect Plugin aus Community Applications.
  2. Konfiguriere das Plugin.
  3. Access API functionality through the GraphQL Sandbox.

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

Loslegen

  1. Die API ist bereits installiert und läuft.
  2. Zugriffseinstellungen unter EinstellungenManagementzugangAPI
  3. Aktiviere die GraphQL Sandbox für die Entwicklung.
  4. Erstelle deinen ersten API-Schlüssel.
  5. Start making GraphQL queries!

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