{"id":26568790,"url":"https://github.com/chris-mc1/unraid_api","last_synced_at":"2026-04-17T00:31:10.375Z","repository":{"id":283864663,"uuid":"946208751","full_name":"chris-mc1/unraid_api","owner":"chris-mc1","description":"Unraid API integration for Home Assistant using the local GraphQL API","archived":false,"fork":false,"pushed_at":"2026-02-13T20:17:08.000Z","size":134,"stargazers_count":61,"open_issues_count":19,"forks_count":11,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-02-14T00:11:56.724Z","etag":null,"topics":["custom-component","hacs","hacs-integration","home-assistant","homeassistant","unraid"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chris-mc1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-10T19:30:43.000Z","updated_at":"2026-02-13T20:17:12.000Z","dependencies_parsed_at":"2025-08-25T17:29:23.100Z","dependency_job_id":null,"html_url":"https://github.com/chris-mc1/unraid_api","commit_stats":null,"previous_names":["chris-mc1/unraid_hass","chris-mc1/unraid_api"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/chris-mc1/unraid_api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-mc1%2Funraid_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-mc1%2Funraid_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-mc1%2Funraid_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-mc1%2Funraid_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chris-mc1","download_url":"https://codeload.github.com/chris-mc1/unraid_api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-mc1%2Funraid_api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31909837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T18:22:33.417Z","status":"ssl_error","status_checked_at":"2026-04-16T18:21:47.142Z","response_time":69,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["custom-component","hacs","hacs-integration","home-assistant","homeassistant","unraid"],"created_at":"2025-03-22T20:17:30.524Z","updated_at":"2026-04-17T00:31:10.361Z","avatar_url":"https://github.com/chris-mc1.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Unraid\n\nThe **Unraid API** integration allows users to integrate their [Unraid](https://unraid.net/) server using Unraids local GraphQL API.\n\n## Install the Integration\n\n1. Go to the HACS -\u003e Custom Repositories and add this repository as a Custom Repository [See HACS Documentation for help](https://hacs.xyz/docs/faq/custom_repositories/)\n\n2. Click the button bellow and click 'Download' to install the Integration:\n\n    [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?repository=unraid_api\u0026owner=chris-mc1)\n\n3. Restart Home Assistant.\n\n## Prerequisites\n\n- Unraid v7.2 or later\n- Create an [API Key](https://docs.unraid.net/API/how-to-use-the-api/#managing-api-keys) with this Template:\n\n```txt\n?name=Homeassistant\u0026scopes=disk%2Binfo%2Bservers%2Bshare%3Aread_any%2Carray%2Bdocker%3Aread_any%2Bupdate_any\u0026description=Unraid+API+Homeassistant+integration\n```\n\nor set permissions manually:\n\n- Read (All):\n  - Info\n  - Servers\n  - Array\n  - Disk\n  - Share\n  - Docker\n\n- Update (All):\n  - Array\n  - Docker\n\n## Setup\n\n1. Click the button below or use \"Add Integration\" in Home Assistant and select \"Unraid\".\n\n  [![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=unraid_api)\n\n1. Enter the URL of the Unraid WebUI including \"http(s)://\" and the port when using a nonstandard port. You must use https when \"Use SSL/TLS:\" is set to \"Yes\" or \"Strict\" in the Unraid Management access settings.\n2. Enter your API Key\n3. Select which aspects of your Server to monitor\n\n### Configuration parameters\n\n- Unraid WebUI: URL of the Unraid WebUI (including \"http(s)://\")\n- API Key: API Key for the Unraid API\n- Monitor Shares: Create Entities for each Network Share\n- Monitor Disks: Create Entities for each Disk\n- Monitor Docker Containers: [Docker mode](#docker)\n\n### Docker\n\nEach monitored container must have a unique name. By default the container name is used, but can be overwritten by setting the `io.home-assistant.unraid_api.name` label on the container.\n\nDocker modes:\n\n- Disabled: Docker monitoring is disabled\n- All (Ignore labels): All container are monitored, regardless of their label.\n- Enabled with Label only: Only Container with `io.home-assistant.unraid_api.name=true` are monitored\n- All except disabled with Label: All container are monitored, Container with `io.home-assistant.unraid_api.name=false` are excluded\n\nAll supported Docker Labels:\n\n- `io.home-assistant.unraid_api.monitor`: Enabled or disable monitoring for this container.\n- `io.home-assistant.unraid_api.name`: Overwrite container name\n- `net.unraid.docker.webui`: WebUI Url in Device page\n- `org.opencontainers.image.version`: Software version shown in Device page and as an extra state attribute\n\n## Entities\n\n- Sensors:\n  - Array: State, Usage, Free space, Used space\n  - RAM: Usage, Free, Used\n  - CPU: Utilization, Temperature, Power\n  - Parity check: Status, Progress, Speed\n  - Disks: Status, Temperature, Usage, Free space, Used space, Spinning\n  - Shares: Free space\n  - UPS: Status, Level, Runtime, Health, Load, Input voltage, Output voltage\n  - Docker Container: State\n\n- Buttons:\n  - Parity check: Start, Stop, Pause, Resume\n\n- Switches:\n  - Docker Container: Start/Stop\n\n## Remove integration\n\nThis integration follows standard integration removal, no extra steps are required.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchris-mc1%2Funraid_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchris-mc1%2Funraid_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchris-mc1%2Funraid_api/lists"}