Passer au contenu principal

Bienvenue sur l'API Unraid

À 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 interagir par programme avec votre serveur Unraid. Elle permet l’automatisation, la surveillance et des capacités d’intégration grâce à une API moderne à typage fort, avec plusieurs méthodes d’authentification (clés API, cookies de session et SSO/OIDC), une couverture complète du système et des outils de développement intégrés.

Disponibilité​

Intégration native (Unraid 7.2+)​

À partir d’Unraid 7.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 → Accès à la gestion → API

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

Pour les versions d’Unraid antérieures à 7.2, ou pour accéder aux fonctionnalités plus récentes de l’API :

  1. Installez le plugin Unraid Connect depuis Applications communautaires.
  2. Configurer le plugin.
  3. Accédez aux fonctionnalités de l’API via le GraphQL Sandbox.

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

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. Activez 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.