mirror/api

mirror of https://github.com/unraid/api.git synced 2026-01-07 09:10:05 -06:00

Files

Eli Bosley f8a6785e9c fix: re-add missing header gradient styles (#1787 )

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Style**
* Enhanced header banner styling: centered, non-repeating cover images
with layered gradient overlays and adjusted user-profile banner
positioning for improved layout.
* **Bug Fixes**
* Banner display logic updated so "image" is treated like "yes" for
showing banner images.
* **Tests**
  * Added unit tests covering banner/theme display behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

2025-11-17 11:03:37 -05:00

.vscode

chore: Remove legacy store modules and add new API key and reporting services (#1536 )

2025-07-25 15:07:37 -04:00

dev

fix(api): decode html entities before parsing notifications (#1768 )

2025-11-07 14:49:22 -05:00

docs

chore: remove deprecated API documentation files and workflow (#1714 )

2025-09-17 13:23:42 -04:00

legacy

feat: code first graphql (#1347 )

2025-04-11 15:03:01 -04:00

scripts

feat: translations now use crowdin (translate.unraid.net) (#1739 )

2025-10-13 16:56:08 -04:00

src

fix: re-add missing header gradient styles (#1787 )

2025-11-17 11:03:37 -05:00

.depcheckrc

chore(api): remove unused dependencies (#1554 )

2025-08-08 15:35:00 -04:00

.dockerignore

…

.env.development

fix(connect): disable api plugin if unraid plugin is absent (#1773 )

2025-11-13 12:26:35 -05:00

.env.production

chore: cli commands for api plugin install & generation (#1352 )

2025-04-22 13:30:11 -04:00

.env.staging

chore: cli commands for api plugin install & generation (#1352 )

2025-04-22 13:30:11 -04:00

.env.test

refactor: implement local-session for internal client auth (#1606 )

2025-08-27 15:28:25 -04:00

.eslintrc.ts

feat: translations now use crowdin (translate.unraid.net) (#1739 )

2025-10-13 16:56:08 -04:00

.gitignore

feat(api): determine if docker container has update (#1582 )

2025-09-09 16:25:32 -04:00

.gqlconfig

fix: replace files lost during pruning

2025-03-27 15:47:29 -04:00

.prettierignore

…

.prettierrc.cjs

…

CHANGELOG.md

fix: flaky watch on boot drive's dynamix config (#1753 )

2025-10-27 11:05:13 -04:00

codegen.ts

fix: no sizeRootFs unless queried (#1710 )

2025-09-16 12:01:49 -04:00

commitlint.config.js

chore: pure ESM (#1202 )

2025-02-25 14:14:14 -05:00

docker-compose.yml

feat: convert to pnpm monorepo (#1137 )

2025-02-19 13:41:23 -05:00

Dockerfile

chore: Revert "fix(deps): update all non-major dependencies" (#1675 )

2025-09-09 08:25:30 -04:00

ecosystem.config.json

fix: rm redundant emission to $HOME/.pm2/logs (#1640 )

2025-09-02 15:30:13 -04:00

generated-schema.graphql

feat: add cpu power query & subscription (#1745 )

2025-11-14 14:27:49 -05:00

justfile

chore: cli commands for api plugin install & generation (#1352 )

2025-04-22 13:30:11 -04:00

package.json

fix(api): decode html entities before parsing notifications (#1768 )

2025-11-07 14:49:22 -05:00

README.md

feat: translations now use crowdin (translate.unraid.net) (#1739 )

2025-10-13 16:56:08 -04:00

tsconfig.json

chore: extract connect to an API plugin (#1367 )

2025-06-10 15:16:26 -04:00

vite.config.ts

feat(api): determine if docker container has update (#1582 )

2025-09-09 16:25:32 -04:00

README.md

@unraid/api

Installation

Install the production plugin via the apps tab (search for "Unraid Connect")

Manual install can be done with the following routes: production staging

CLI

If you're on a unraid v6.9.2 or later machine this should be available by running unraid-api in any directory.

root@Devon:~# unraid-api

Unraid API

  Thanks for using the official Unraid API

Usage:

  $ unraid-api command <options>

Commands:

  start/stop/restart/version/status/report/switch-env

Options:

  -h, --help                                                   Prints this usage guide.
  -d, --debug                                                  Enabled debug mode.
  -p, --port string                                            Set the graphql port.
  --environment production/staging/development                 Set the working environment.
  --log-level ALL/TRACE/DEBUG/INFO/WARN/ERROR/FATAL/MARK/OFF   Set the log level.

  Copyright © 2024 Lime Technology, Inc.

Key

To create and work with Unraid API keys, used for the local API, run the following command to view all available options. These options may change over time.

unraid-api key --help

Report

To view the current status of the unraid-api and its connection to mothership, run:

unraid-api report

To view verbose data (anonymized), run:

unraid-api report -v

To view non-anonymized verbose data, run:

unraid-api report -vv

Secrets

If you found this file you're likely a developer. If you'd like to know more about the API and when it's available please join our discord.

Internationalization

Run pnpm --filter @unraid/api i18n:extract to scan the Nest.js source for translation helper usages and update src/i18n/en.json with any new keys. The extractor keeps existing translations intact and appends new keys with their English source text.

README.md

@unraid/api

Installation

CLI

Key

Report

Secrets

Internationalization

License