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.

Key features

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 the heartbeat your server sends to QuickBox Central. Telemetry is off by default on new installs; it only runs after you turn it on. Servers installed before this default changed keep whatever setting they already had.

To turn it on or off, use the toggle in the Telemetry panel, or run:

qb manage telemetry -o on
qb manage telemetry -o off
qb manage telemetry -o status

When telemetry is on, the server sends one heartbeat every 5 minutes by default. You can change the schedule from the panel, but a server is shown offline in your QuickBox account after 7 minutes without a heartbeat, so a longer interval makes it appear offline between check-ins. The data is tied to your license and server, so it is not anonymous. Each heartbeat contains:

• Server identity — hostname, public and local IP address, operating system, and the QuickBox and dashboard versions
• Licensing — your license key and server instance ID, which authenticate the request, plus the number of seats in use
• Hardware and load — CPU model, core count, frequency and usage, load averages, uptime, and total, used, and free memory and disk
• Network — interface name, current speeds, monthly received and sent totals, and your latest speed test result (download, upload, ping, jitter, test tool, and time)
• User accounts — every account’s username, email address, active status, and last login, with that user’s pending application updates (application, installed version, and available version)

With telemetry off, your license, update checks, and every dashboard feature work normally. Your QuickBox account still lists the server, but it cannot show whether the server is online, because online status comes from the heartbeat. A server is marked offline after 7 minutes without one. For the full field list and how the account dashboard uses it, see Server Telemetry.

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

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

Best practices

FAQ

Related pages