mirror/api

mirror of https://github.com/unraid/api.git synced 2025-12-31 05:29:48 -06:00

Files

github-actions[bot] c39b0b267c chore(main): release 4.29.2 (#1857 )

🤖 I have created a release *beep* *boop*
---


## [4.29.2](https://github.com/unraid/api/compare/v4.29.1...v4.29.2)
(2025-12-19)


### Bug Fixes

* unraid-connect plugin not loaded when connect is installed
([#1856](https://github.com/unraid/api/issues/1856))
([73135b8](73135b8328))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

2025-12-19 15:13:29 -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: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

docs

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

legacy

Revert "feat!(api): swap daemonizer to nodemon instead of PM2" (#1836 )

2025-12-12 18:32:35 -05:00

scripts

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

src

fix: unraid-connect plugin not loaded when connect is installed (#1856 )

2025-12-19 15:06:52 -05:00

.depcheckrc

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

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

.dockerignore

…

.env.development

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

.env.production

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

.env.staging

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

.env.test

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

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

.eslintrc.ts

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

.gitignore

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

.gqlconfig

…

.prettierignore

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

.prettierrc.cjs

…

CHANGELOG.md

chore(main): release 4.29.2 (#1857 )

2025-12-19 15:13:29 -05:00

codegen.ts

fix: no sizeRootFs unless queried (#1710 )

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

commitlint.config.js

…

docker-compose.yml

…

Dockerfile

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

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

ecosystem.config.json

fix(api): timeout on startup on 7.0 and 6.12 (#1844 )

2025-12-16 11:37:42 -05:00

generated-schema.graphql

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

justfile

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05:00

package.json

chore(main): release 4.29.2 (#1857 )

2025-12-19 15:13:29 -05:00

README.md

fix: revert replace docker overview table with web component (7.3+) (#1853 )

2025-12-19 12:12:41 -05: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