API Settings

The API Settings page manages your QuickBox Pro API connection and provides tools for local integrations. It is organized into four sections: API Status, Telemetry, Local API Keys, and the API Playground.

Admin only

API Settings requires admin privileges (admin.system.api permission). Navigate to System > API Control from the sidebar.

Key features

🔗 API Status

View your connection status to QuickBox Central and manage API credentials

📊 Telemetry Controls

Enable or disable optional telemetry reporting to QuickBox

🔑 Local API Keys

Generate and manage API keys for local integrations and automation

🧪 API Playground

Test API endpoints interactively from within the dashboard

API status

The API Status banner shows the current connection status between your server and QuickBox Central. This connection validates your license and enables update checks.

From this section you can:

View credentials status — See whether your API key is active and validated
Edit credentials — Update your Central API key if it has changed or needs to be refreshed

A valid API connection is required for license validation, update checks, and accessing the QuickBox software catalog.

Telemetry

The Telemetry panel controls whether your server sends anonymous usage data to QuickBox. Telemetry is opt-in and includes:

Heartbeat — Periodic check-in with QuickBox Central to confirm server health
Usage data — Anonymous, aggregated information about installed software and server configuration

You can enable or disable telemetry at any time. Disabling telemetry does not affect your license, update access, or any server functionality.

Local API keys

Generate API keys for local integrations and automation scripts. Local API keys allow external tools to interact with your QuickBox Pro dashboard API without using session-based authentication.

Managing keys

Create a key — Generate a new API key. Each key can have read, write, or both permissions
Revoke a key — Immediately invalidate a key so it can no longer be used for authentication
View active keys — See all generated keys with their creation date and permission scope

Key security

Treat API keys like passwords. Store them securely, do not share them in public channels, and revoke any key you suspect has been compromised.

API playground

The API Playground lets you test API endpoints interactively from within the dashboard. Send requests to any available endpoint and view the response directly — useful for verifying integrations or exploring the API before writing automation scripts.

Select an endpoint and method
Provide request parameters or body content
Execute the request and inspect the response
Save frequently used requests for quick access

CLI equivalent

Dashboard Action	CLI Command
View API status	`qb manage api -o status`
Set API key	`qb manage api -k <key> -o activate`
Deactivate API	`qb manage api -o deactivate`
Send heartbeat	`qb manage api -o heartbeat`
Check connection	`qb manage api -o check`

Dashboard advantage

The API Playground and local API key management are dashboard-exclusive features. The CLI provides basic API key activation and status checks, but the interactive playground is only available through the web interface.

Best practices

Do

Keep your Central API key current — an expired or invalid key prevents update checks and license validation
Generate separate local API keys for each integration so you can revoke them independently if needed
Use the API Playground to test requests before building automation scripts — it is the fastest way to verify endpoint behavior
Review your active API keys periodically and revoke any that are no longer in use

Don't

Don't share your Central API key or local API keys publicly — they grant access to your server's API
Don't generate a single API key for all integrations — if it is compromised, revoking it breaks everything
Don't disable telemetry and then wonder why your server does not appear in your QuickBox portal overview — the heartbeat is part of telemetry

FAQ

Your server will not be able to check for updates, validate the license, or access the software catalog from QuickBox Central. All installed software continues to run normally — only the update and license check features are affected.

No. Disabling telemetry only stops the anonymous usage reports sent to QuickBox. Your license, updates, software, and all dashboard features continue to work normally.

Yes. Local API keys are designed for exactly this purpose. Include the key in the authorization header of your HTTP requests to authenticate with the dashboard API from scripts, cron jobs, or third-party tools.

You can update your Central API key directly from the API Status banner on this page. If you need a new key, generate one from your account on v3.quickbox.io and enter it here.

General Settings

Server configuration and feature flags

System Monitoring

Monitor server health and resource usage

Updates & Changelog

Check for updates and view release notes

CLI Reference

Full command-line reference for QuickBox Pro

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

Dedicated Support

Feature Previews

Community Configs

Active Discussions

Join Discord Server