get_console_firmware
get_console_firmware
Section titled “get_console_firmware”Show UniFi OS firmware and available-update state.
Requires a console session, not the Network API key: UniFi OS’s own
endpoints do not accept X-API-Key. Set UNIFI_OS_USERNAME and
UNIFI_OS_PASSWORD to enable this tool. Without them it returns a
clear configuration error rather than a bare 401.
UNVERIFIED RESPONSE SHAPE: the endpoint is confirmed to exist on UCG-Fiber / UniFi OS 5.1.19 (it answers 401 rather than 404 without a session), but its response body has not been observed — no console credentials were available when this tool was written. The raw body is passed through untransformed rather than reshaped against a guessed schema.
Side effects: None (read-only, plus a login if no session is active).
Returns the console’s raw firmware/update record under firmware.
Example
Section titled “Example”get_console_firmware(controller="default")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
controller |
string |
no | “default” | Name of the UniFi controller to target. Defaults to "default". |