Skip to content

mst

ibox.mst in the library, ibox mst in the CLI.

Query and manage Parental Control: Max Surf Time (MST).

status

status() -> str

Get Max Surf Time (MST) status

config

config(id: str) -> str

Get Max Surf Time (MST) settings

Parameters:

Name Type Description Default
id str

MST entry ID.

required

get

get() -> str

Get all Max Surf Time (MST) entries

set

set(mac: str, enable: bool = True, minutes_per_day: int | None = None, allowed_time: dict | None = None) -> str

Create or update a device's daily internet time limit (Max Surf Time).

Days you don't give keep their current limit. A new entry starts at 1440 minutes (unlimited) every day.

Parameters:

Name Type Description Default
mac str

device MAC address, or its MST entry ID (see get()).

required
enable bool

whether the limit is enforced. Default is True.

True
minutes_per_day int | None

limit for every day of the week, 0-1440 minutes.

None
allowed_time dict | None

limit per day in minutes, e.g. {"Sat": 240, "Sun": 240}. Overrides minutes_per_day for the days given.

None

Returns:

Name Type Description
str str

response content

delete

delete(mac: str) -> str

Delete a device's daily internet time limit (Max Surf Time) entry.

Parameters:

Name Type Description Default
mac str

device MAC address, or its MST entry ID (see get()).

required

Returns:

Name Type Description
str str

response content

stats

stats(id: str) -> str

Get Max Surf Time (MST) statistics

Parameters:

Name Type Description Default
id str

MST entry ID.

required