Property:rest config.lua

---

BoxMatrix >> Webinterface >> rest_config.lua

@ BoxMatrix   -   IRC-Chat   -   Translate: de es fr it nl pl

News

Selectors

Models

Accessories

Components

Environment

Config

Commands

System

Webif

Software

Develop

Lexicon

Community

Project

Media

---

UI-Structure

UI-Modules

HTML-Files

XML-Files

Lua-Scripts

Javascript

Browser

SSI-Files

SSI-Directives

HTML-Text

Event-Text

Help-Pages

CSS-Files

Graphics

Research

---

Lua-Script

Lua-Script:	rest_config.lua   -   type Script	Wiki	Freetz	IPPF	whmf	AVM	Web
Location:	Webinterface >> Lua-Scripts   -   Origin: AVM
Path:	Release: /usr/rest_api Lab+Rel: /usr/rest_api
Properties:	Size: 3.2k - 4.0k   -   Firmware: 7.39 - 8.00
Function:	REST-API Module Loader

Goto:   Modules  -  Functions  -  Dependencies   -   Model-Matrix   -   SMW-Browser

Details

rest_config.lua is the REST-API Module Loader. It is included by api.lua.

It loads all Modules, each of which represents one or more custom endpoints.

Each REST-API Module provides a endPointNames table containing all endpoints which should be listed in the overview,
and a getRestRessources method, which returns a ressource table with handler function pointers for all supported
endpoints, request methods and pathes.

Although all modules are polymorph they are not loaded by wildcard, Each module is loaded separately by the
load_rest_module function, permitting to tweak their parameters.

rest_config.lua provides the 2 collected and merged tables by getEndpoints and getRestRessources,
which could be handled in api.lua like loading a single module.

REST-API:

• Lexicon: REST-API
• Commands: scgi_server
• Ports: Port-8187-tcp
• UI-Mods: webui
• API-Root: api.lua
• Includes: api_generic.lua, rest_config.lua, security.lua, espresso.lua
• Includes: rest_api_const.lua, response.lua, error.lua, avmluamessages.lua
• Includes: uimod.lua, api_generic_filter.lua, resource.lua
• Modules: storagenasrights_rest.lua, webusb_rest.lua
• Modules: calllog_rest.lua, faxjournal_rest.lua, phonebook_rest.lua
• Modules: smarthome_rest.lua, boxnotify_rest.lua
• Develop: obl_fboxname.lua, dev_debug.lua, landevice.lua
• Develop: query_tree.lua, fake_modules.lua, obl.lua

Modules

8 modules were tested in early fw 7.39, but only 2 of them made it to release 7.50. This likely changes again.

This is a subset of the Lua-Scripts section, filtered for all *_rest.lua files in /usr/rest_api,
including the demo module obl_fboxname.lua:

Daily updated index of all lua scripts found scanning Firmware-Probes . Last update: 2024-11-14 06:51 GMT.
The label (static) in the Script column shows there are other objects in this wiki using this name.
The Mod column shows the amount of models using the respective script. Click the column header to sort by this number.

Script	Mod	Firmware	Description	Path	Size/Bytes	Type	Origin
boxnotify_rest.lua	30	7.39 - 8.00	REST-API module for box notifications	/usr/rest_api	2.1k - 2.3k	Script	AVM
calllog_rest.lua	30	7.39 - 8.00	REST-API module for the Phone-Calls and TAM-Calls	/usr/rest_api	5.9k - 6.1k	Script	AVM
faxjournal_rest.lua	30	7.39 - 8.00	REST-API module for the Fax-Journal	/usr/rest_api	3.3k - 3.6k	Script	AVM
obl_fboxname.lua	10	7.39	REST-API Demo Module	/usr/rest_api	8.0k	Script	AVM
phonebook_rest.lua	14	7.39 - 7.81	REST-API module for the Phonebook	/usr/rest_api	12.9k	Script	AVM
smarthome_rest.lua	30	7.39 - 8.00	REST-API module for Smarthome	/usr/rest_api	43.6k - 49.7k	Script	AVM
storagenasrights_rest.lua	38	7.39 - 8.00	REST-API module for NAS access permissions	/usr/rest_api	10.8k - 12.2k	Script	AVM
webusb_rest.lua	38	7.39 - 8.00	REST-API module for NAS handling	/usr/rest_api	3.3k - 6.6k	Script	AVM
8 Lua scripts

Functions

The function names of scripts often help to understand function blocks (and show gaps in the docs). fw 7.50 functions:

$ grep -e '^function' -e '^local function' /usr/rest_api/rest_config.lua

local function configConcat(configTab, configPartTab)
local function getOblOverview(path)

# debug to /dev/console
function mydbg(txt, data)

# todo
function load_rest_module(luaFile, rootPath, endPointConfigs, overViewTable)

# todo
function restConfig.getRestRessources(rootPath)

# todo
function restConfig.getEndpoints() 

Dependencies

Daily updated index of all dependencies of this script. Last update: 2024-11-14 08:31 GMT.
A * in the Mod column marks info from Supportdata-Probes, which will always stay incomplete.
If an Object includes itself then this is a file with the same name but another Path and the dependencies are merged.

Relation	Typ	Object	Mod	Firmware	Info	Origin
Requires	lua	response.lua	38	7.39 - 8.00	REST-API Response API	AVM
Required by	lua	api.lua	37	7.39 - 8.00	REST-API Lua-Land root for scgi_server	AVM
2 dependencies for this script

Model-Matrix

Daily updated index of the presence, path and size of this script for each model. Last update: 2024-11-14 06:51 GMT.
Showing all models using this script. Click any column header (click-wait-click) to sort the list by the respective data.
The (main/scrpn/boot/arm/prx/atom/rtl) label in the Model column shows which CPU is meant for Multi-Linux models.
Note that this list is merged from Firmware-Probes of all known AVM firmware for a model, including Recovery.exe and Labor-Files.

Model	Firmware	Path	Size/Bytes
FRITZ!Box 4040	7.39 - 8.00	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 4050	7.58 - 7.90	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 4060	7.39 - 7.90	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 5530 Fiber (main)	7.39 - 8.00	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 5590 Fiber (main)	7.39 - 8.00	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 5590 Fiber (prx)	7.70 - 8.00	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 5690 Pro (main)	7.62 - 7.90	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 6490 Cable (atom)	7.39 - 7.51	/usr/rest_api	3.9k
FRITZ!Box 6590 Cable (atom)	7.39 - 7.51	/usr/rest_api	3.9k
FRITZ!Box 6591 Cable (arm)	8.00	/usr/rest_api	3.2k
FRITZ!Box 6591 Cable (atom)	7.39 - 8.00	/usr/rest_api	3.2k - 4.0k
FRITZ!Box 6660 Cable (arm)	7.90 - 8.00	/usr/rest_api	3.2k
FRITZ!Box 6660 Cable (atom)	7.39 - 8.00	/usr/rest_api	3.2k - 4.0k
FRITZ!Box 6670 Cable (arm)	7.90	/usr/rest_api	3.2k
FRITZ!Box 6670 Cable (atom)	7.61 - 7.90	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 6690 Cable (arm)	7.90	/usr/rest_api	3.2k
FRITZ!Box 6690 Cable (atom)	7.39 - 7.90	/usr/rest_api	3.2k - 4.0k
FRITZ!Box 6820 LTE v1 (main)	7.51	/usr/rest_api	3.9k
FRITZ!Box 6820 LTE v2 (main)	7.51	/usr/rest_api	3.9k
FRITZ!Box 6820 LTE v3 (main)	7.51 - 7.57	/usr/rest_api	3.9k
FRITZ!Box 6850 LTE	7.39 - 7.90	/usr/rest_api	3.2k - 4.0k
FRITZ!Box 6850 5G	7.39 - 7.90	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 6890 LTE (main)	7.39 - 7.57	/usr/rest_api	3.9k - 4.0k
FRITZ!Box 6890 LTE v1 (main)	7.39 - 7.57	/usr/rest_api	3.9k - 4.0k
FRITZ!Box 6890 LTE v2 (main)	7.39 - 7.57	/usr/rest_api	3.9k - 4.0k
FRITZ!Box 7490 (main)	7.51	/usr/rest_api	3.9k
FRITZ!Box 7510	7.39 - 8.00	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 7520	7.39 - 8.00	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 7520 v2 (main)	7.39 - 8.00	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 7530	7.39 - 8.00	/usr/rest_api	3.2k - 4.0k
FRITZ!Box 7530 AX	7.39 - 8.00	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 7583 (main)	7.50 - 7.59	/usr/rest_api	3.9k
FRITZ!Box 7583 VDSL (main)	7.59 - 8.00	/usr/rest_api	3.2k - 3.9k
FRITZ!Box 7590 (main)	7.39 - 8.00	/usr/rest_api	3.2k - 4.0k
FRITZ!Box 7590 AX (main)	7.39 - 8.00	/usr/rest_api	3.2k - 4.0k
FRITZ!Box 7690	7.61 - 7.90	/usr/rest_api	3.2k - 3.9k
FRITZ!Repeater 2400	7.39	/usr/rest_api	3.8k - 4.0k
FRITZ!Powerline 1240 AX	7.57 - 7.58	/usr/rest_api	3.9k
38 models use this script

SMW-Browser

Property:rest config.lua

Information is currently being retrieved from the backend.