Skip to main content

UpdateUPSSettingsRequest

connectionUPSConnectionrequired

Connection choice: a USB-attached UPS Hoserva drives locally, or a remote NUT server this host monitors.

Possible values: [usb, network]

driverstring

Required for USB. NUT driver name (e.g. usbhid-ups).

Possible values: non-empty

portstring

Required for USB. Driver port (commonly "auto").

Possible values: non-empty

monitorPasswordstring

Write-only. Required on first USB configure; omit on later updates to keep the stored secret.

Possible values: non-empty

networkHoststring

Required for network. Remote NUT server host.

Possible values: non-empty

networkPortinteger<int32>

Remote NUT port. Defaults to 3493 when omitted.

Possible values: >= 1 and <= 65535

networkUpsNamestring

Required for network. UPS name on the remote server.

Possible values: non-empty

networkUsernamestring

Required for network. Monitoring username.

Possible values: non-empty

networkPasswordstring

Write-only. Required on first network configure; omit on later updates to keep the stored secret.

Possible values: non-empty

lowBatteryPercentinteger<int32>

USB-only low-battery charge percent.

Possible values: >= 0 and <= 100

runtimeSecondsinteger<int32>

USB-only low-battery runtime seconds.

Possible values: >= 0

UpdateUPSSettingsRequest
{
"connection": "usb",
"driver": "string",
"port": "string",
"monitorPassword": "string",
"networkHost": "string",
"networkPort": 0,
"networkUpsName": "string",
"networkUsername": "string",
"networkPassword": "string",
"lowBatteryPercent": 0,
"runtimeSeconds": 0
}