freebox-mcp
This MCP server exposes the full Freebox OS API, allowing an LLM to monitor and control virtually every aspect of a Freebox router/gateway.
AirMedia: Get/update AirMedia configuration, list connected receivers, and send media to them.
Call Log: Retrieve, update, delete call entries; mark all as read or delete all at once.
Connection: Get connection status and configuration; update settings (remote access, Wake-on-LAN, ping, ad blocking); manage DDNS providers and status; retrieve xDSL/FTTH line stats (rate, SNR, attenuation); manage IPv6 configuration.
Contacts: Full CRUD for contacts including phone numbers, addresses, URLs, and emails.
DHCP: Get/update DHCP server config (IP range, gateway, DNS); view dynamic leases; create, read, update, and delete static leases.
Downloads: List, add, update, and delete download tasks (HTTP, FTP, BitTorrent, NZB); manage peers, pieces, trackers, files, blacklists, and logs; view download stats.
Download Configuration: Configure global download settings including BitTorrent (DHT, PEX, crypto), newsgroups (SSL, auth, auto-extract/repair), throttling modes, watch directories, and concurrent task limits.
Download RSS Feeds: List, create, update, delete, and refresh RSS feeds; browse feed items, mark as read, and enqueue items for download.
Freeplug: List powerline networks and devices, view tx/rx stats, and reset specific Freeplug devices.
File System: List directories, get file info, create directories, copy/move/rename/delete files, archive, extract, hash, repair, and read file contents.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@freebox-mcp list devices on my LAN"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
freebox-mcp
A spec-driven Model Context Protocol server for the Freebox OS API — exposing the entire local API of your Freebox Server to any MCP client (Claude, etc.) as ready-to-call tools.
Every tool is generated from an OpenAPI 3.1 document that is itself auto-generated from the official Freebox documentation (https://dev.freebox.fr/sdk/os/). When Free ships a new API version, a scheduled job on a France-reachable host regenerates the spec; on a change it ships a release automatically — no hand-written tool code to maintain.
Three bricks, one contract
┌── 1. SCRAPER ──┐ ┌──── 2. GENERATOR ────┐ ┌─── 3. GENERATED CLIENT ───┐
official docs ─► tools/cache ─────────► spec/freebox-openapi.json ─► FastMCP.from_openapi() ─► MCP tools
(dev.freebox.fr) (html + objects.inv) (pure Python — no AI) (raw output — no edits)The whole pipeline is deterministic — no AI anywhere. The scraper and generator are pure
Python; the generated client is the verbatim output of FastMCP.from_openapi(spec) — no tool is
hand-added, edited, pre-processed, or post-processed. A CI test (test_tools_are_raw_generated_output)
enforces the last step: every exposed tool must be an operationId from the generated spec, or the
build fails.
The only hand-written code is the authenticated transport the generated client runs on (discovery · HMAC session · TLS · envelope unwrap) — things no API spec can express. It is generic, never edited per-endpoint, and app registration / login live in the CLI, not as injected tools.
Exhaustive — every documented operation across every section (wifi, lan, connection, calls, contacts, downloads, fs, nat, dhcp, vpn server + client, pvr, parental control, airmedia, system, …) becomes a tool.
login(auth handshake) and/ws/(WebSocket) are excluded. Runfreebox-mcp sectionsfor the live list and counts.Self-maintaining — regeneration runs on a France-reachable host (GitHub-hosted runners can't reach
dev.freebox.fr); on a doc change it auto-releases. See Regenerating the spec below.Secure — app-token never leaves your machine, HMAC-SHA1 sessions, TLS verified against the bundled Freebox root CAs,
0600credential store. See SECURITY.md.
Quick start
# 1. Authorize the app on your Freebox (one time — press the button on the box).
uvx freebox-mcp authorize
# 2. Point your MCP client at it (stdio).
uvx freebox-mcpauthorize is a one-time physical confirmation (Freebox anti-hijack design). After it, the
token is saved and every later session opens automatically — you never touch the box again.
MCP client config (Claude Desktop / Claude Code)
{
"mcpServers": {
"freebox": { "command": "uvx", "args": ["freebox-mcp"] }
}
}Docker
docker run -i --rm -v ~/.config/freebox-mcp:/home/app/.config/freebox-mcp \
ghcr.io/nelson-proia/freebox-mcp(The container needs LAN access to the box; on Linux add --network host.)
Run from source, no install
uvx --from git+https://github.com/Nelson-PROIA/freebox-mcp freebox-mcp discoverRelated MCP server: trollspace-mcp
What you can do
Because the whole API is exposed, an LLM can chain real tasks:
List every device on the LAN, then reboot the box.
Set up a port-forward / NAT redirect for a self-hosted service.
Schedule a TV recording on the PVR and manage existing recordings.
Toggle wifi, change the SSID/passphrase, split 2.4/5 GHz bands.
Read live xDSL / FTTH line stats (rate, SNR, attenuation).
Apply per-device parental controls and time schedules.
Configure the built-in VPN server and provision VPN client tunnels.
Manage downloads + RSS feeds, FTP, network shares, Freeplug & switch ports.
CLI
freebox-mcp run the MCP server over stdio (default)
freebox-mcp --http run over streamable-HTTP (--host/--port)
freebox-mcp authorize register the app (press the button on the box)
freebox-mcp login open a session and print granted permissions
freebox-mcp discover print discovery info and the chosen transport
freebox-mcp tools list the generated MCP tools
freebox-mcp sections list API sections + tool counts (values for FREEBOX_SECTIONS)
freebox-mcp call OP [JSON] invoke one operation, e.g. `freebox-mcp call get_system`Configuration
Env var | Default | Purpose |
|
|
|
| — | Force a base URL, e.g. |
| — | Comma list to expose only some sections, e.g. |
| — | Comma list of sections to hide. |
|
| App identity on the box. |
Scoping the sections keeps the tool surface small when you only care about a few areas.
Permissions. Configuration-changing tools need the
settingspermission. Grant it (andparental, etc.) for this app in the Freebox OS web UI: Paramètres ▸ Gestion des accès ▸ Applications — no walking to the box.
Regenerating the spec
python -m tools.build # scrape live docs → parse → emit spec/freebox-openapi.json
python -m tools.build --offline # rebuild from the committed cache (deterministic; what CI verifies)dev.freebox.fr blocks GitHub-hosted runner IPs, so the scrape runs on a France-reachable host
— e.g. a weekly cron on an always-on Raspberry Pi (scripts/regenerate.sh). On a spec change it
bumps the version, tags, and pushes; the GitHub release pipeline (which needs no access to the
docs host) then publishes PyPI + signed GHCR + GitHub Release automatically.
Development
uv sync --group dev
uv run pytest # unit + integration (mocked); add FREEBOX_TEST=1 for live
uv run ruff check . && uv run ruff format .License
MIT — see LICENSE. Not affiliated with Free / Iliad.
Available Tools
226 toolsdelete_address_number_address_url_email_idC
Deletes the ContactNumber with the given id.
Error codes: noent, exists, no_match
Inputs: id (required). Returns: object
delete_call_log_idB
Deletes the CallEntry with the given id.
Error codes: internal_error, invalid_id
Inputs: id (required). Returns: object
delete_contact_idB
Deletes the ContactEntry with the given id.
Error codes: noent, exists, no_match
Inputs: id (required). Returns: object
delete_dhcp_static_lease_idD
Error codes: inval, inval_netmask, inval_ip_range, inval_ip_range_net, inval_gw_net, exist, nodev, noent, netdown, busy
Inputs: id (required).
delete_downloads_blacklist_hostD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: host (required).
delete_downloads_feeds_idA
Deletes the DownloadFeed and all the associated items. This will not alter the Download tasks.
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: id (required). Returns: object
delete_downloads_idA
Deletes the Download task with the given id, without erasing the downloaded files If the task was not done it is stopped You can call this method to remove done tasks from the task list.
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: id (required). Returns: object
delete_downloads_id_eraseC
Same as previous, but erases the downloaded files
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: id (required).
delete_downloads_task_id_blacklist_emptyD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: task_id (required).
delete_downloads_task_id_trackers_announceD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: task_id (required), announce (required).
delete_email_number_address_url_email_idC
Deletes the ContactNumber with the given id.
Error codes: noent, exists, no_match
Inputs: id (required). Returns: object
delete_fs_tasks_idA
Deletes the FsTask task with the given id, if the task was running, stop it. No rollback is done, if a file as already been processed it will be left as is.
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: id (required). Returns: object
delete_fw_redir_redir_idC
Delete a PortForwardingConfig
Error codes: noent, internal_error, exist
Inputs: redir_id (required). Returns: object
delete_number_number_address_url_email_idB
Deletes the ContactNumber with the given id.
Error codes: noent, exists, no_match
Inputs: id (required). Returns: object
delete_parental_filter_idA
Deletes the ParentalFilter rule with the given id
Error codes: inval, exist, noent
Inputs: id (required). Returns: object
delete_pvr_finished_idC
Delete a Frecord and associated files
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: id (required). Returns: object
delete_pvr_programmed_idD
Delete a Precord
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: id (required). Returns: object
delete_upload_cleanA
Deletes all the FileUpload not in_progress
Error codes: invalid_request, path_not_found, access_denied, destination_conflict, invalid_id, cancelled
Inputs: no named parameters. Returns: object
delete_upload_idC
Delete the given FileUpload closing the connection if needed
Error codes: invalid_request, path_not_found, access_denied, destination_conflict, invalid_id, cancelled
Inputs: id (required). Returns: object
delete_upload_id_cancelA
Cancel the given FileUpload closing the connection The upload status must be in_progress
Error codes: invalid_request, path_not_found, access_denied, destination_conflict, invalid_id, cancelled
Inputs: id (required). Returns: object
delete_upnpigd_redir_idC
Deletes the given UPnPRedir
Error codes: disabled, noent
Inputs: id (required). Returns: object
delete_url_number_address_url_email_idC
Deletes the ContactNumber with the given id.
Error codes: noent, exists, no_match
Inputs: id (required). Returns: object
delete_vpn_client_config_idC
Deletes the VPNClientConfig
Error codes: inval, nomem, ioerror, nodev, noent, netdown, exist, busy, none, internal, authentication_failed, auth_failed, resolv_failed, connect_timeout, connect_failed, setup_control_failed, setup_call_failed, protocol, remote_terminated, remote_disconnect
Inputs: id (required). Returns: object
delete_vpn_connection_idD
Deletes the VPNUser
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: id (required). Returns: object
delete_vpn_user_loginC
Deletes the VPNUser
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: login (required). Returns: object
delete_wifi_mac_filter_filter_idC
Delete the WifiMacFilter with the given id
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: filter_id (required). Returns: object
get_address_number_address_url_email_idC
Returns the ContactNumber with the given id
Error codes: noent, exists, no_match
Inputs: id (required). Returns: object
get_airmedia_configB
Returns the current AirMediaConfig
Error codes: unknown_target, no_client, set_pass, set_onscreen_code, no_ctrl, http, bad_session, bad_name, bad_device_id, bad_remote_id, req_in_progress, fetch, no_display, playback_state, no_slideshow_srv, no_mem, inout_file, no_volume_control, connect, unauthorized, unsupported_media, bad_type, unimplemented
Inputs: no named parameters. Returns: object
get_airmedia_receiversB
Get the list of AirMediaReceiver connected to the Freebox Server
Error codes: unknown_target, no_client, set_pass, set_onscreen_code, no_ctrl, http, bad_session, bad_name, bad_device_id, bad_remote_id, req_in_progress, fetch, no_display, playback_state, no_slideshow_srv, no_mem, inout_file, no_volume_control, connect, unauthorized, unsupported_media, bad_type, unimplemented
Inputs: no named parameters. Returns: object
get_call_logB
Returns the collection of all CallEntry call entries
Error codes: internal_error, invalid_id
Inputs: no named parameters. Returns: object
get_call_log_idA
Returns the CallEntry task with the given id
Error codes: internal_error, invalid_id
Inputs: id (required). Returns: object
get_connectionA
Returns the current ConnectionStatus
Error codes: inval, nodev, noent, netdown, busy, invalid_port, insecure_password, invalid_provider, invalid_next_hop
Inputs: no named parameters. Returns: object
get_connection_configB
Returns the current ConnectionConfiguration
Error codes: inval, nodev, noent, netdown, busy, invalid_port, insecure_password, invalid_provider, invalid_next_hop
Inputs: no named parameters. Returns: object
get_connection_ddns_providerC
Returns the current DDNSConfig
Error codes: inval, nodev, noent, netdown, busy, invalid_port, insecure_password, invalid_provider, invalid_next_hop
Inputs: provider (required). Returns: object
get_connection_ddns_provider_statusC
Returns the current DDNSStatus
Error codes: inval, nodev, noent, netdown, busy, invalid_port, insecure_password, invalid_provider, invalid_next_hop
Inputs: provider (required). Returns: object
get_connection_ftthB
Returns the current FtthStatus
Error codes: inval, nodev, noent, netdown, busy, invalid_port, insecure_password, invalid_provider, invalid_next_hop
Inputs: no named parameters. Returns: object
get_connection_ipv6_configB
Returns the current ConnectionIpv6Configuration
Error codes: inval, nodev, noent, netdown, busy, invalid_port, insecure_password, invalid_provider, invalid_next_hop
Inputs: no named parameters. Returns: object
get_connection_xdslB
Returns the current XdslInfos
Error codes: inval, nodev, noent, netdown, busy, invalid_port, insecure_password, invalid_provider, invalid_next_hop
Inputs: no named parameters. Returns: object
get_contactA
Returns the collection of all ContactEntry
Error codes: noent, exists, no_match
Inputs: no named parameters. Returns: object
get_contact_contact_id_numbers_addresses_urls_emailsC
Returns the collection of all ContactNumber for a given contact
Error codes: noent, exists, no_match
Inputs: contact_id (required). Returns: object
get_contact_idB
Returns the ContactEntry with the given id
Error codes: noent, exists, no_match
Inputs: id (required). Returns: object
get_dhcp_configB
Returns the current DhcpConfig
Error codes: inval, inval_netmask, inval_ip_range, inval_ip_range_net, inval_gw_net, exist, nodev, noent, netdown, busy
Inputs: no named parameters. Returns: object
get_dhcp_dynamic_leaseD
Error codes: inval, inval_netmask, inval_ip_range, inval_ip_range_net, inval_gw_net, exist, nodev, noent, netdown, busy
Inputs: no named parameters. Returns: object
get_dhcp_static_leaseD
Error codes: inval, inval_netmask, inval_ip_range, inval_ip_range_net, inval_gw_net, exist, nodev, noent, netdown, busy
Inputs: no named parameters. Returns: object
get_dhcp_static_lease_idD
Error codes: inval, inval_netmask, inval_ip_range, inval_ip_range_net, inval_gw_net, exist, nodev, noent, netdown, busy
Inputs: id (required). Returns: object
get_dl_pathD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: path (required). Returns: object
get_downloadsA
Returns the collection of all Download tasks
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: no named parameters. Returns: object
get_downloads_configB
Returns the current DownloadConfiguration
Inputs: no named parameters. Returns: object
get_downloads_feedsA
Returns the collection of all DownloadFeed feeds
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: no named parameters. Returns: object
get_downloads_feeds_feed_id_itemsA
Returns the collection of all DownloadFeedItems for a given DownloadFeed
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: feed_id (required). Returns: object
get_downloads_feeds_idA
Gets the DownloadFeed with the given id
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: id (required). Returns: object
get_downloads_idB
Returns the Download task with the given id
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: id (required). Returns: object
get_downloads_id_logD
Get the log.
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: id (required). Returns: object
get_downloads_statsD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: no named parameters. Returns: object
get_downloads_task_id_blacklistD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: task_id (required). Returns: object
get_downloads_task_id_filesD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: task_id (required). Returns: object
get_downloads_task_id_peersD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: task_id (required). Returns: object
get_downloads_task_id_piecesD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: task_id (required). Returns: object
get_downloads_task_id_trackersD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: task_id (required). Returns: object
get_email_number_address_url_email_idD
Returns the ContactNumber with the given id
Error codes: noent, exists, no_match
Inputs: id (required). Returns: object
get_freeplugB
Returns the list of FreeplugNetwork
Error codes: inval, nomem, nosta, nopeer
Inputs: no named parameters. Returns: object
get_freeplug_idD
Returns the list of Freeplug
Error codes: inval, nomem, nosta, nopeer
Inputs: id (required). Returns: object
get_fs_info_pathC
Returns the FileInfos for the given path
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: path (required). Returns: object
get_fs_ls_pathB
Returns the list of FileInfos for the given path
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: path (required). Returns: object
get_fs_tasksB
Returns the collection of all FsTask tasks
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters. Returns: object
get_fs_tasks_idC
Returns the FsTask task with the given id
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: id (required). Returns: object
get_fs_tasks_id_hashD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: id (required). Returns: object
get_ftp_configB
Get the FtpConfig
Error codes: internal_error, weak_password
Inputs: no named parameters. Returns: object
get_fw_dmzB
Returns the current DmzConfig
Error codes: noent, internal_error, exist
Inputs: no named parameters. Returns: object
get_fw_incomingD
Error codes: noent, internal_error, exist
Inputs: no named parameters. Returns: object
get_fw_incoming_port_idC
Returns the requested IncomingPortConfig properties
Error codes: noent, internal_error, exist
Inputs: port_id (required). Returns: object
get_fw_redirD
Error codes: noent, internal_error, exist
Inputs: no named parameters. Returns: object
get_fw_redir_redir_idC
Returns the requested PortForwardingConfig properties
Error codes: noent, internal_error, exist
Inputs: redir_id (required). Returns: object
get_lan_browser_interfaceB
Returns the list of LanHost on this interface
Error codes: noent, internal_error, ioerror, inval, inval_gateway_ip, nodev, nohost, nomem, netdown
Inputs: interface (required). Returns: object
get_lan_browser_interface_hostidC
Returns the requested LanHost properties
Error codes: noent, internal_error, ioerror, inval, inval_gateway_ip, nodev, nohost, nomem, netdown
Inputs: interface (required), hostid (required). Returns: object
get_lan_browser_interfacesD
Error codes: noent, internal_error, ioerror, inval, inval_gateway_ip, nodev, nohost, nomem, netdown
Inputs: no named parameters. Returns: object
get_lan_configB
Returns the current LanConfig
Error codes: noent, internal_error, ioerror, inval, inval_gateway_ip, nodev, nohost, nomem, netdown
Inputs: no named parameters. Returns: object
get_lcd_configB
Get the LcdConfig
Error codes: inval, no_panel, setup
Inputs: no named parameters. Returns: object
get_number_number_address_url_email_idC
Returns the ContactNumber with the given id
Error codes: noent, exists, no_match
Inputs: id (required). Returns: object
get_parental_configB
Get the ParentalFilterConfig
Error codes: inval, exist, noent
Inputs: no named parameters. Returns: object
get_parental_filterA
Returns the collection of all ParentalFilter rules.
Error codes: inval, exist, noent
Inputs: no named parameters. Returns: object
get_parental_filter_idA
Returns the ParentalFilter rule with the given id
Error codes: inval, exist, noent
Inputs: id (required). Returns: object
get_parental_filter_id_planningB
Returns the ParentalFilterPlanning for the filter with the given id
Error codes: inval, exist, noent
Inputs: id (required). Returns: object
get_pvr_configB
Returns the current PvrConfig
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: no named parameters. Returns: object
get_pvr_finishedD
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: no named parameters. Returns: object
get_pvr_finished_idD
Returns the requested Frecord
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: id (required). Returns: object
get_pvr_mediaC
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: no named parameters. Returns: object
get_pvr_programmedD
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: no named parameters. Returns: object
get_pvr_programmed_idD
Returns the requested Precord
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: id (required). Returns: object
get_pvr_quotaD
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: no named parameters. Returns: object
get_rrdD
Same as post request, but allowed without ‘settings’ permission
Inputs: no named parameters. Returns: object
get_storage_configB
Get the StorageConfig
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Inputs: no named parameters. Returns: object
get_storage_diskB
Returns the collection of all StorageDisk
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Inputs: no named parameters. Returns: object
get_storage_disk_idC
Returns the StorageDisk with the given id
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Inputs: id (required). Returns: object
get_storage_partitionB
Returns the collection of all DiskPartition
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Inputs: no named parameters. Returns: object
get_storage_partition_idB
Returns the DiskPartition with the given id
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Inputs: id (required). Returns: object
get_switch_port_idA
Get the SwitchPortConfig for the given port id
Error codes: bad_port, bad_speed, bad_link, bad_mac_entry_type
Inputs: id (required). Returns: object
get_switch_port_id_statsA
Get the SwitchPortStats for the given port id
Error codes: bad_port, bad_speed, bad_link, bad_mac_entry_type
Inputs: id (required). Returns: object
get_switch_statusB
Return the list of swith port status SwitchPortStatus
Error codes: bad_port, bad_speed, bad_link, bad_mac_entry_type
Inputs: no named parameters. Returns: object
get_systemC
Get the SystemConfig
Inputs: no named parameters. Returns: object
get_uploadD
Error codes: invalid_request, path_not_found, access_denied, destination_conflict, invalid_id, cancelled
Inputs: no named parameters. Returns: object
get_upload_idC
With this API you can track the progress of your FileUpload task
Error codes: invalid_request, path_not_found, access_denied, destination_conflict, invalid_id, cancelled
Inputs: id (required). Returns: object
get_upnpav_configA
Get the UPnPAVConfig
Error codes: internal_error
Inputs: no named parameters. Returns: object
get_upnpigd_configB
Get the UPnPIGDConfig
Error codes: disabled, noent
Inputs: no named parameters. Returns: object
get_upnpigd_redirA
Get the list of UPnPRedir redirections
Error codes: disabled, noent
Inputs: no named parameters. Returns: object
get_url_number_address_url_email_idB
Returns the ContactNumber with the given id
Error codes: noent, exists, no_match
Inputs: id (required). Returns: object
get_vpnC
Get the list of VPNServer
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: no named parameters. Returns: object
get_vpn_client_configC
Get the list of VPNClientConfig
Error codes: inval, nomem, ioerror, nodev, noent, netdown, exist, busy, none, internal, authentication_failed, auth_failed, resolv_failed, connect_timeout, connect_failed, setup_control_failed, setup_call_failed, protocol, remote_terminated, remote_disconnect
Inputs: no named parameters. Returns: object
get_vpn_client_config_idC
Get the VPNClientConfig
Error codes: inval, nomem, ioerror, nodev, noent, netdown, exist, busy, none, internal, authentication_failed, auth_failed, resolv_failed, connect_timeout, connect_failed, setup_control_failed, setup_call_failed, protocol, remote_terminated, remote_disconnect
Inputs: id (required). Returns: object
get_vpn_client_logD
Error codes: inval, nomem, ioerror, nodev, noent, netdown, exist, busy, none, internal, authentication_failed, auth_failed, resolv_failed, connect_timeout, connect_failed, setup_control_failed, setup_call_failed, protocol, remote_terminated, remote_disconnect
Inputs: no named parameters. Returns: object
get_vpn_client_statusB
Get the VPNClientStatus
Error codes: inval, nomem, ioerror, nodev, noent, netdown, exist, busy, none, internal, authentication_failed, auth_failed, resolv_failed, connect_timeout, connect_failed, setup_control_failed, setup_call_failed, protocol, remote_terminated, remote_disconnect
Inputs: no named parameters. Returns: object
get_vpn_connectionD
Get the list of VPNUser
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: no named parameters. Returns: object
get_vpn_download_config_server_name_loginA
Download an OpenVPN configuration file for the given server and login WARNING: each time you download a new configuration file for a particular user, you invalidate previous configuration file emitted for this user
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: server_name (required), login (required). Returns: object
get_vpn_ip_poolD
Gets the VPNUser with the given login
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: no named parameters. Returns: object
get_vpn_userC
Get the list of VPNUser
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: no named parameters. Returns: object
get_vpn_user_loginB
Gets the VPNUser with the given login
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: login (required). Returns: object
get_vpn_vpn_id_configC
Get the VPNServerConfig
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: vpn_id (required). Returns: object
get_wifi_apA
Get the list of Freebox Access Points WifiAp
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: no named parameters. Returns: object
get_wifi_ap_idB
Get the WifiAp with the requested id
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id (required). Returns: object
get_wifi_ap_id_allowed_channel_combB
Get the WifiAllowedComb for the given ap id
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id (required). Returns: object
get_wifi_ap_id_channel_usageC
Get the list of WifiChannelUsage for the given AP
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id (required). Returns: object
get_wifi_ap_id_neighborsC
Get the list of WifiNeighbor seen by the AP
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id (required). Returns: object
get_wifi_ap_id_stationsC
Get the list of WifiStation associated to the AP
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id (required). Returns: object
get_wifi_bssB
Get the list of Freebox Access Points WifiBss
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: no named parameters. Returns: object
get_wifi_bss_idB
Get the WifiBss with the requested id
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id (required). Returns: object
get_wifi_configB
Get the WifiGlobalConfig
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: no named parameters. Returns: object
get_wifi_mac_filterB
Get the list of WifiMacFilter
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: no named parameters. Returns: object
get_wifi_mac_filter_filter_idC
Returns the requested WifiMacFilter properties
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: filter_id (required). Returns: object
get_wifi_planningC
Get the list of WifiChannelUsage for the given AP
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: no named parameters. Returns: object
post_address_number_address_url_emailC
Creates the ContactNumber
Error codes: noent, exists, no_match
Inputs: id, contact_id, type, number, +2 more. Returns: object
post_airmedia_receviers_receiver_nameD
Error codes: unknown_target, no_client, set_pass, set_onscreen_code, no_ctrl, http, bad_session, bad_name, bad_device_id, bad_remote_id, req_in_progress, fetch, no_display, playback_state, no_slideshow_srv, no_mem, inout_file, no_volume_control, connect, unauthorized, unsupported_media, bad_type, unimplemented
Inputs: receiver_name (required).
post_call_log_delete_allC
Remove all CallEntry call entries
Error codes: internal_error, invalid_id
Inputs: id, type, datetime, number, +4 more. Returns: object
post_call_log_mark_all_as_readC
Mark all CallEntry call entries as read
Error codes: internal_error, invalid_id
Inputs: id, type, datetime, number, +4 more. Returns: object
post_contactB
Creates a new ContactEntry
Error codes: noent, exists, no_match
Inputs: id, display_name, first_name, last_name, +8 more. Returns: object
post_dhcp_static_leaseD
Error codes: inval, inval_netmask, inval_ip_range, inval_ip_range_net, inval_gw_net, exist, nodev, noent, netdown, busy
Inputs: body. Returns: object
post_downloads_addD
NOTE: instead of passing password and username you can include them in the URL.
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: no named parameters. Returns: object
post_downloads_blacklistD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: no named parameters. Returns: object
post_downloads_feedsC
Creates a new DownloadFeed .
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: id, status, url, title, +8 more. Returns: object
post_downloads_feeds_feed_id_items_item_id_downloadB
This method will enqueue the RSS item to the download list
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: feed_id (required), item_id (required).
post_downloads_feeds_feed_id_items_mark_all_as_readC
This method will mark each items as read
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: feed_id (required).
post_downloads_feeds_fetchA
Remotely fetches all the RSS feeds.
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: no named parameters.
post_downloads_feeds_id_fetchA
Remotely fetches the RSS feed and updates it. Note that if the remote feed specifies a TTL, trying to update before the ttl will result in feed_is_recent error
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: id (required).
post_downloads_task_id_trackersD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: task_id (required).
post_email_number_address_url_emailC
Creates the ContactNumber
Error codes: noent, exists, no_match
Inputs: id, contact_id, type, number, +2 more. Returns: object
post_freeplug_id_resetC
reset the given Freeplug
Error codes: inval, nomem, nosta, nopeer
Inputs: id__path (required), id, local, net_role, +9 more. Returns: object
post_fs_archiveD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters. Returns: object
post_fs_catD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters. Returns: object
post_fs_cpD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters. Returns: object
post_fs_extractD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters. Returns: object
post_fs_hashD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters. Returns: object
post_fs_mkdirD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters.
post_fs_mvD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters. Returns: object
post_fs_renameD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters.
post_fs_repairD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters. Returns: object
post_fs_rmD
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: no named parameters. Returns: object
post_fw_redirC
Create a PortForwardingConfig
Error codes: noent, internal_error, exist
Inputs: id, enabled, ip_proto, wan_port_start, +7 more. Returns: object
post_lan_wol_interfaceD
Send a wake on LAN packet to the specified host with an optional password
Error codes: noent, internal_error, ioerror, inval, inval_gateway_ip, nodev, nohost, nomem, netdown
Inputs: interface (required).
post_number_number_address_url_emailC
Creates the ContactNumber
Error codes: noent, exists, no_match
Inputs: id, contact_id, type, number, +2 more. Returns: object
post_parental_filterC
Add a parental filter rule
Error codes: inval, exist, noent
Inputs: body. Returns: object
post_pvr_programmedC
Create a new Precord ** Example request**: ** Example response**:
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: id, media, path, has_record_gen, +18 more. Returns: object
post_rrdD
post_rrd
Inputs: no named parameters.
post_system_rebootB
Reboot the Freebox
Inputs: no named parameters.
post_url_number_address_url_emailC
Creates the ContactNumber
Error codes: noent, exists, no_match
Inputs: id, contact_id, type, number, +2 more. Returns: object
post_vpn_client_configB
Creates a new VPNClientConfig .
Error codes: inval, nomem, ioerror, nodev, noent, netdown, exist, busy, none, internal, authentication_failed, auth_failed, resolv_failed, connect_timeout, connect_failed, setup_control_failed, setup_call_failed, protocol, remote_terminated, remote_disconnect
Inputs: id, description, type, active, +6 more. Returns: object
post_vpn_userC
Creates a new VPNUser .
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: login, password, password_set, ip_reservation. Returns: object
post_wifi_ap_id_neighbors_scanB
Launch a wifi scan on given ap
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id (required).
post_wifi_config_resetC
Crate a new the WifiMacFilter
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id, mac, comment, type, +2 more. Returns: object
post_wifi_mac_filterC
Crate a new the WifiMacFilter
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id, mac, comment, type, +2 more. Returns: object
put_address_number_address_url_email_idB
Updates the ContactNumber with the given id
Error codes: noent, exists, no_match
Inputs: id__path (required), id, contact_id, type, +3 more. Returns: object
put_airmedia_configB
Update the current AirMediaConfig
Error codes: unknown_target, no_client, set_pass, set_onscreen_code, no_ctrl, http, bad_session, bad_name, bad_device_id, bad_remote_id, req_in_progress, fetch, no_display, playback_state, no_slideshow_srv, no_mem, inout_file, no_volume_control, connect, unauthorized, unsupported_media, bad_type, unimplemented
Inputs: enabled, password. Returns: object
put_call_log_idC
Updates the CallEntry task with the given id
Error codes: internal_error, invalid_id
Inputs: id__path (required), id, type, datetime, +5 more. Returns: object
put_connection_configC
Updates the ConnectionConfiguration
Error codes: inval, nodev, noent, netdown, busy, invalid_port, insecure_password, invalid_provider, invalid_next_hop
Inputs: ping, is_secure_pass, remote_access, remote_access_port, +8 more. Returns: object
put_connection_ddns_providerC
Set the DDNSConfig
Error codes: inval, nodev, noent, netdown, busy, invalid_port, insecure_password, invalid_provider, invalid_next_hop
Inputs: provider (required), enabled, hostname, password, +1 more. Returns: object
put_connection_ipv6_configC
Updates the ConnectionIpv6Configuration
Error codes: inval, nodev, noent, netdown, busy, invalid_port, insecure_password, invalid_provider, invalid_next_hop
Inputs: ipv6_enabled, ipv6ll, delegations. Returns: object
put_contact_idB
Updates the ContactEntry with the given id
Error codes: noent, exists, no_match
Inputs: id__path (required), id, display_name, first_name, +9 more. Returns: object
put_dhcp_configC
Update the current DhcpConfig
Error codes: inval, inval_netmask, inval_ip_range, inval_ip_range_net, inval_gw_net, exist, nodev, noent, netdown, busy
Inputs: enabled, sticky_assign, gateway, netmask, +4 more. Returns: object
put_dhcp_static_lease_idD
Error codes: inval, inval_netmask, inval_ip_range, inval_ip_range_net, inval_gw_net, exist, nodev, noent, netdown, busy
Inputs: id (required), body.
put_downloads_configC
Updates the DownloadConfiguration
Inputs: max_downloading_tasks, download_dir, watch_dir, use_watch_dir, +7 more. Returns: object
put_downloads_feeds_feed_id_items_item_idD
Returns the collection of all DownloadFeedItems for a given DownloadFeed
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: feed_id (required), item_id (required), id, status, +10 more. Returns: object
put_downloads_feeds_idB
Updates the DownloadFeed task with the given id
Error codes: feed_not_found, item_not_found, feed_is_recent, internal_error
Inputs: id__path (required), id, status, url, +9 more. Returns: object
put_downloads_idB
Updates the Download task with the given id
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: id__path (required), id, type, name, +18 more. Returns: object
put_downloads_task_id_files_file_idD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: task_id (required), file_id (required).
put_downloads_task_id_trackers_announceD
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Inputs: task_id (required), announce (required).
put_downloads_throttlingB
You can force the throttling mode using this method. You can use any of the throttling modes defined in DlThrottlingConfig . Setting to schedule will automatically set correct throttling mode. Other values will force the throttling mode until you set it back to schedule.
Inputs: normal, slow, schedule, mode. Returns: object
put_email_number_address_url_email_idC
Updates the ContactNumber with the given id
Error codes: noent, exists, no_match
Inputs: id__path (required), id, contact_id, type, +3 more. Returns: object
put_fs_tasks_idC
Updates the FsTask task with the given id
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Inputs: id__path (required), id, type, state, +16 more. Returns: object
put_ftp_configC
Update the FtpConfig
Error codes: internal_error, weak_password
Inputs: enabled, allow_anonymous, allow_anonymous_write, password, +5 more. Returns: object
put_fw_dmzD
Update the current LanConfig
Error codes: noent, internal_error, exist
Inputs: ip, name, name_dns, name_mdns, +2 more. Returns: object
put_fw_incoming_port_idC
Update a IncomingPortConfig properties
Error codes: noent, internal_error, exist
Inputs: port_id (required), id, enabled, active, +6 more. Returns: object
put_fw_redir_redir_idB
Update a PortForwardingConfig properties
Error codes: noent, internal_error, exist
Inputs: redir_id (required), id, enabled, ip_proto, +8 more. Returns: object
put_lan_browser_interface_hostidC
Update a LanHost properties
Error codes: noent, internal_error, ioerror, inval, inval_gateway_ip, nodev, nohost, nomem, netdown
Inputs: interface (required), hostid (required), id, primary_name, +11 more. Returns: object
put_lan_configB
Update the current LanConfig
Error codes: noent, internal_error, ioerror, inval, inval_gateway_ip, nodev, nohost, nomem, netdown
Inputs: ip, name, name_dns, name_mdns, +2 more. Returns: object
put_lcd_configB
Update the LcdConfig
Error codes: inval, no_panel, setup
Inputs: brightness, orientation_forced, orientation. Returns: object
put_number_number_address_url_email_idA
Updates the ContactNumber with the given id
Error codes: noent, exists, no_match
Inputs: id__path (required), id, contact_id, type, +3 more. Returns: object
put_parental_configC
Update the ParentalFilterConfig
Error codes: inval, exist, noent
Inputs: default_filter_mode. Returns: object
put_parental_filter_idC
Updates the ParentalFilter rule with the given id
Error codes: inval, exist, noent
Inputs: id__path (required), id, macs, hosts, +10 more. Returns: object
put_parental_filter_id_planningB
Update the ParentalFilterPlanning for the parental filter rule with the given id
Error codes: inval, exist, noent
Inputs: id (required), resolution, cdayranges, mapping. Returns: object
put_pvr_configC
Update the current PvrConfig
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: margin_before, margin_after. Returns: object
put_pvr_finished_idC
Update a Frecord properties
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: id__path (required), id, media, path, +17 more. Returns: object
put_pvr_programmed_idC
Update a Precord properties
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: id__path (required), id, media, path, +19 more. Returns: object
put_pvr_quotaC
Request next quota threshold. You don’t have to provide any arguments, the quota will be adjusted automatically if needed.
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Inputs: body. Returns: object
put_storage_configC
Update the StorageConfig
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Inputs: external_pm_enabled, external_pm_idle_before_spindown. Returns: object
put_storage_disk_idC
Enable/Disable a disk
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Inputs: id (required), body. Returns: object
put_storage_disk_id_formatA
Format the disk with the given id To be able to format a disk you need to provide the following parameters (JSON encoded). There will be one partition using all the available space on disk. All previous data will be lost. This parameters will be ignored if you format the Freebox internal disk NOTE: once started you can monitor the format process getting the disk information (see StorageDisk operation_pct field)
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Inputs: id__path (required), id, type, state, +14 more. Returns: object
put_storage_partition_idC
Enable/Disable a partition
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Inputs: id (required), body. Returns: object
put_storage_partition_id_checkC
Checks the partition with the given id To be able to check a partition you need to provide the following parameters (JSON encoded): NOTE: once started you can monitor the fsck process getting the partition information (see DiskPartition operation_pct field)
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Inputs: id__path (required), id, disk_id, state, +8 more. Returns: object
put_switch_port_idB
Update the SwitchPortConfig for the given port id
Error codes: bad_port, bad_speed, bad_link, bad_mac_entry_type
Inputs: id__path (required), id, duplex, speed. Returns: object
put_upnpav_configC
Update the UPnPAVConfig
Error codes: internal_error
Inputs: enabled. Returns: object
put_upnpigd_configC
Update the UPnPIGDConfig
Error codes: disabled, noent
Inputs: enabled, version. Returns: object
put_url_number_address_url_email_idC
Updates the ContactNumber with the given id
Error codes: noent, exists, no_match
Inputs: id__path (required), id, contact_id, type, +3 more. Returns: object
put_vpn_client_config_idC
Update the VPNServerConfig
Error codes: inval, nomem, ioerror, nodev, noent, netdown, exist, busy, none, internal, authentication_failed, auth_failed, resolv_failed, connect_timeout, connect_failed, setup_control_failed, setup_call_failed, protocol, remote_terminated, remote_disconnect
Inputs: id__path (required), id, type, enabled, +14 more. Returns: object
put_vpn_openvpn_routed_configC
Update the VPNServerConfig
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: id, type, enabled, enable_ipv4, +13 more. Returns: object
put_vpn_user_loginC
Updates the VPNUser task with the given login
Error codes: inval, exist, noent, nomem, unsupp, inuse, busy, ioerror, size
Inputs: login__path (required), login, password, password_set, +1 more. Returns: object
put_wifi_ap_idC
Update the WifiAp
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id__path (required), id, name, status, +2 more. Returns: object
put_wifi_bss_idC
Update the WifiAp
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: id__path (required), id, name, status, +2 more. Returns: object
put_wifi_configC
Update the WifiGlobalConfig
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: enabled, mac_filter_state. Returns: object
put_wifi_mac_filter_filter_idC
Update a WifiMacFilter properties
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: filter_id (required), id, mac, comment, +3 more. Returns: object
put_wifi_planningD
Get the list of WifiChannelUsage for the given AP
Error codes: inval, exist, nospc, nodev, noent, busy, inval_band, inval_ssid, inval_freq, inval_cipher, inval_key_len, inval_key, inval_ht_mode, inval_ht_needs_wmm, inval_ac_needs_ht, inval_ac_not_2d4g
Inputs: channel, band, noise_level, rx_busy_percent. Returns: object
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 226 tools
Many tools have overlapping descriptions, especially the contact number variants (delete_address_number_address_url_email_id, delete_email_number_address_url_email_id, etc.) which all do the same thing. Additionally, the sheer number of tools (226) makes it hard to distinguish between similar operations in different domains.
The tools follow a consistent verb_noun pattern derived from REST API endpoints, but there are inconsistencies: some tools use abbreviations (get_dl_path vs get_downloads) and the noun parts can be overly long and repetitive (e.g., 'address_number_address_url_email'). Overall, the pattern is recognizable but not clean.
With 226 tools, the server is extremely bloated. While it covers many router features, this volume is excessive for an MCP server and likely includes many redundant or overly granular operations that could be consolidated.
The tools cover a wide range of domains (connection, DHCP, downloads, filesystem, firewall, LAN, parental control, PVR, storage, VPN, WiFi), but there are noticeable gaps like user management and system updates. The presence of many similarly named contact tools suggests redundancy rather than full coverage.
Maintenance
Related MCP Connectors
An MCP server that let you interact with Cycloid.io Internal Development Portal and Platform
MCP server for progressive tool usage at any scale (see https://klavis.ai)
MCP server for the FFmpeg Micro video transcoding API — create, monitor, download transcodes.
An MCP server that provides read access to your cloud storage providers, bank accounts and more.
Related MCP Servers
- AlicenseBqualityDmaintenanceA configurable MCP server that adapts any HTTP API into an MCP toolset with generic HTTP tools (GET, POST, PUT, DELETE) and pluggable authentication. Includes API discovery scripts and supports dynamic tool generation from OpenAPI specs or wordlist scans.51MIT
- AlicenseBqualityCmaintenanceMCP server for the Trollspace API that exposes 47 type-safe tools for managing snippets, nuggets, todos, ideas, tools, repos, travel, subscriptions, and more.551Apache 2.0
- AlicenseAqualityDmaintenanceA Model Context Protocol (MCP) server for interfacing with AVM FRITZ!Box routers. Control smart home devices, monitor network status, and administer your router through any MCP-compatible client.10MIT
- AlicenseNot gradedqualityCmaintenanceMCP server for the FreeFeed social network API. Enables reading timelines, posts, comments, and attachments, as well as writing posts, comments, and managing subscriptions.1MIT