Passer au contenu principal

Bienvenue sur l'API Unraid

What's Nouveau

À partir de Unraid OS v7.2, l'API est intégrée au système d'exploitation - aucune installation de plugin requise !

L'API Unraid fournit une interface GraphQL pour l'interaction programmatique avec votre serveur Unraid. Elle permet l'automatisation, la surveillance et des capacités d'intégration.

📦 Disponibilité​

✨ Intégration native (Unraid OS v7.2+)​

À partir de Unraid OS v7.2, l'API est intégrée directement dans le système d'exploitation :

  • Aucune installation de plugin requise
  • Disponible automatiquement au démarrage du système
  • Intégration système profonde
  • Accès via Paramètres → Gestion de l'accès → API

🔌 Installation de plugin (avant 7.2 et utilisateurs avancés)​

Pour les versions d'Unraid antérieures à la v7.2 ou pour accéder à de nouvelles fonctionnalités de l'API :

  1. Installer le plugin Unraid Connect depuis Applications Communautaires
  2. Configurer le plugin
  3. Accéder aux fonctionnalités de l'API via le GraphQL Sandbox
Important Notes
  • Le plugin Unraid Connect fournit l'API pour les versions avant la 7.2
  • Vous n'avez PAS besoin de vous connecter à Unraid Connect pour utiliser l'API localement
  • Installer le plugin sur 7.2+ vous donne accès à de nouvelles fonctionnalités API avant qu'elles ne soient incluses dans les versions OS

📚 Sections de documentation​

Référence complète pour toutes les commandes CLI

Apprenez à interagir avec l'API GraphQL

Configurer les fournisseurs d'authentification SSO

Voir ce qui arrive ensuite

🌟 Caractéristiques principales​

Core Capacités

L'API fournit :

  • Interface GraphQL : API moderne et flexible avec typage fort
  • Authentification : Plusieurs méthodes incluant les clés API, cookies de session, et SSO/OIDC
  • Couverture complète : Accès aux informations système, gestion de matrice et opérations Docker
  • Outils pour développeurs : Bac à sable GraphQL intégré, configurable via une interface web ou CLI
  • Accès basé sur les rôles : Contrôle des permissions granulaires
  • Gestion web : Gérez les clés API et paramètres via l'interface web

🚀 Commencer​

  1. L'API est déjà installée et en fonctionnement
  2. Accédez aux paramètres via Paramètres → Gestion de l'accès → API
  3. Activer le bac à sable GraphQL pour le développement
  4. Créez votre première clé API
  5. Commencez à faire des requêtes GraphQL !

Pour des instructions d'utilisation détaillées, voir la référence Commandes CLI.