Skip to content

Unraid API: Python Library for Unraid GraphQL API

PyPI version License: MIT Tests

A comprehensive Python library that provides a clean, intuitive interface to Unraid's GraphQL API. It enables developers to programmatically control and monitor Unraid servers with both synchronous and asynchronous support, strong typing, and intelligent error handling.

Features

  • Complete coverage of Unraid GraphQL API endpoints
  • Both synchronous and asynchronous client interfaces
  • Strongly-typed Pydantic models
  • Comprehensive error handling
  • API key authentication
  • Built-in query caching
  • Real-time subscription support
  • Extensive documentation and examples
  • Command-line interface tool

Getting Started

  • Install and configure the Unraid API client

API Reference

  • Explore the complete API documentation

Command Line Interface

  • Learn how to use the built-in CLI

Development

  • Contribute to the project and learn our development process

Example Usage

Python
from unraid_api import UnraidClient

# Connect to Unraid server with API key
client = UnraidClient("192.168.1.10", api_key="your-api-key")

# Get system info
system_info = client.get_system_info()
print(f"System version: {system_info.version}")

# Get Docker containers
containers = client.docker.get_containers()
for container in containers:
    print(f"Container: {container.name}, Status: {container.status}")

License

This project is licensed under the MIT License.