CLI Commands
All commands follow the pattern: unraid-api <command> [options]
π Service Managementβ
Startβ
unraid-api start [--log-level <level>]
Starts the Unraid API service.
Options:
--log-level
: Set logging level (trace|debug|info|warn|error)
Stopβ
unraid-api stop [--delete]
Stops the Unraid API service.
--delete
: Optional. Delete the PM2 home directory
Restartβ
unraid-api restart
Restarts the Unraid API service.
Logsβ
unraid-api logs [-l <lines>]
View the API logs.
-l, --lines
: Optional. Number of lines to tail (default: 100)
βοΈ Configuration Commandsβ
Configβ
unraid-api config
Displays current configuration values.
Switch Environmentβ
unraid-api switch-env [-e <environment>]
Switch between production and staging environments.
-e, --environment
: Optional. Target environment (production|staging)
Developer Modeβ
You can also manage developer options through the web interface at Settings β Management Access β Developer Options
unraid-api developer # Interactive prompt for tools
unraid-api developer --sandbox true # Enable GraphQL sandbox
unraid-api developer --sandbox false # Disable GraphQL sandbox
unraid-api developer --enable-modal # Enable modal testing tool
unraid-api developer --disable-modal # Disable modal testing tool
Configure developer features for the API:
- GraphQL Sandbox: Enable/disable Apollo GraphQL sandbox at
/graphql
- Modal Testing Tool: Enable/disable UI modal testing in the Unraid menu
API Key Managementβ
You can also manage API keys through the web interface at Settings β Management Access β API Keys
API Key Commandsβ
unraid-api apikey [options]
Create and manage API keys via CLI.
Options:
--name <name>
: Name of the key--create
: Create a new key-r, --roles <roles>
: Comma-separated list of roles-p, --permissions <permissions>
: Comma-separated list of permissions-d, --description <description>
: Description for the key
SSO (Single Sign-On) Managementβ
For OIDC/SSO provider configuration, see the web interface at Settings β Management Access β API β OIDC or refer to the OIDC Provider Setup guide.
SSO Base Commandβ
unraid-api sso
Add SSO Userβ
unraid-api sso add-user
# or
unraid-api sso add
# or
unraid-api sso a
Add a new user for SSO authentication.
Remove SSO Userβ
unraid-api sso remove-user
# or
unraid-api sso remove
# or
unraid-api sso r
Remove a user (or all users) from SSO.
List SSO Usersβ
unraid-api sso list-users
# or
unraid-api sso list
# or
unraid-api sso l
List all configured SSO users.
Validate SSO Tokenβ
unraid-api sso validate-token <token>
# or
unraid-api sso validate
# or
unraid-api sso v
Validates an SSO token and returns its status.
Report Generationβ
Generate Reportβ
unraid-api report [-r] [-j]
Generate a system report.
-r, --raw
: Display raw command output-j, --json
: Display output in JSON format
Notesβ
- Most commands require appropriate permissions to modify system state
- Some commands require the API to be running or stopped
- Store API keys securely as they provide system access
- SSO configuration changes may require a service restart