Saltar al contenido principal

Bienvenido a la API de Unraid

What's Nuevo

A partir de Unraid OS v7.2, la API está integrada en el sistema operativo - ¡no se requiere instalación de plugins!

La API de Unraid proporciona una interfaz GraphQL para la interacción programática con tu servidor Unraid. Permite la automatización, el monitoreo y las capacidades de integración.

📦 Disponibilidad​

✨ Integración Nativa (Unraid OS v7.2+)​

A partir de Unraid OS v7.2, la API está integrada directamente en el sistema operativo:

  • No se requiere instalación de plugins
  • Disponible automáticamente al iniciar el sistema
  • Integración profunda con el sistema
  • Acceso a través de Settings → Management Access → API

🔌 Instalación de Plugin (Pre-7.2 y Usuarios Avanzados)​

Para versiones de Unraid anteriores a v7.2 o para acceder a nuevas características de la API:

  1. Instale el Plugin Unraid Connect desde Aplicaciones de Comunidad
  2. Configure el plugin
  3. Accede a la funcionalidad de la API a través del GraphQL Sandbox
Important Notas
  • El plugin Unraid Connect proporciona la API para versiones pre-7.2
  • NO necesita iniciar sesión en Unraid Connect para usar la API localmente
  • La instalación del plugin en 7.2+ le brinda acceso a nuevas características de la API antes de que se incluyan en las versiones del sistema operativo

📚 Secciones de Documentación​

Referencia completa para todos los comandos de CLI

Aprenda a interactuar con la API de GraphQL

Configure proveedores de autenticación SSO

Mira qué viene a continuación

🌟 Características Clave​

Core Capacidades

La API proporciona:

  • Interfaz GraphQL: API moderna y flexible, con tipos robustos
  • Autenticación: Múltiples métodos incluidos API keys, cookies de sesión y SSO/OIDC
  • Cobertura Integral: Acceso a información del sistema, gestión de arrays y operaciones de Docker
  • Herramientas para Desarrolladores: Sandbox de GraphQL integrado configurable mediante interfaz web o CLI
  • Acceso Basado en Roles: Control granular de permisos
  • Gestión Web: Gestione API keys y configuraciones a través de la interfaz web

🚀 Comience​

  1. La API ya está instalada y funcionando
  2. Acceda a configuraciones en Settings → Management Access → API
  3. Habilite el GraphQL Sandbox para desarrollo
  4. Cree su primera API key
  5. ¡Comience a realizar consultas GraphQL!

Para instrucciones de uso detalladas, vea la referencia de CLI Commands.