Property:rest api const.lua

---

BoxMatrix >> Webinterface >> rest_api_const.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

REST-API

Lua-Scripts

Javascript

Browser

SSI-Files

SSI-Directives

HTML-Text

Event-Text

Help-Pages

CSS-Files

Graphics

Research

---

RESTAPI-Script

RESTAPI-Script:	rest_api_const.lua   -   type Script	Wiki	Freetz	IPPF	whmf	AVM	Web
Location:	Webinterface >> RESTAPI-Scripts   -   Origin: AVM
Path:	Release: /usr/rest_api Lab+Rel: /usr/rest_api
Properties:	Size: 1.4k - 4.0k   -   Firmware: 7.39 - 8.00
Function:	REST-API Const Tables

Goto:   Variables  -  Error-Codes  -  Error-Strings  -  Dependencies   -   Model-Matrix   -   SMW-Browser

Details

rest_api_const.lua fills REST-API Const Tables and global variables. It is included by nearly all API related Lua-Scripts.

REST-API:

• Lexicon: REST, API, SCGI
• 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, rest_api_const.lua, response.lua, error.lua
• Includes: avmluamessages.lua, uimod.lua, api_generic_filter.lua, resource.lua, datatype.lua, plugin_common.lua
• Modules: storagenasrights_rest.lua, webusb_rest.lua
• Modules: calllog_rest.lua, faxjournal_rest.lua, phonebook_rest.lua, smarthome_rest.lua, boxnotify_rest.lua
• Develop: obl_fboxname.lua, dev_debug.lua, landevice.lua, query_tree.lua, fake_modules.lua, obl.lua
• Common: array.lua, common.lua, func.lua, math.lua, string.lua, table.lua, typecheck.lua, validcheck.lua
• Plugins: configflags.lua, eventlog.lua, info.lua, monitor.lua, phonebook.lua, smarthome.lua, timermix.lua
• Misc-Plugins: misc.lua, boxname.lua, configuration.lua, handsets.lua, update_status.lua, wan_status.lua
• Setup-Plugins: setup.lua

Variables

Global variables used to create the request URI. Excerpt from fw 7.50:

rest_api_const.api_root_path = "/api"
rest_api_const.api_version = "0"
rest_api_const.api_path = rest_api_const.api_root_path .. "/v" .. rest_api_const.api_version

Error-Codes

HTTP error codes which are sent to the client. Excerpt from fw 7.50:

--! The error codes which will be used to send to the client.

rest_api_const.status_code = {

    -- Request is wrong
    LUA_INVALID_REQUEST           = 201,
    LUA_NO_PERMISSION             = 202,
    LUA_INTERNAL                  = 203,

    -- UI MOD (Group) Errors and BACKEND errors
    BACKEND_INVALID_REQUEST        = 301,
    BACKEND_2FA_NEEDED             = 302,
    BACKEND_2FA_BUSY               = 303,
    BACKEND_2FA_BLOCKED            = 304,
    BACKEND_FAIL                   = 339,

    -- If DATA from UIMOD is not as expected
    -- eg. list entry not found
    LUA_UI_DATA_INVALID           = 401,
    LUA_UI_DATA_NOT_FOUND         = 402

}

Error-Strings

HTTP error codes which are sent to the client. Excerpt from fw 7.50:

-- map to convert the status codes (@see scgi_server.h) of a transaction into
-- human readable error messages.

ui_cmd_result_map[0] = "ok"
ui_cmd_result_map[-1] = "internal error"
ui_cmd_result_map[-2] = "bad key"
ui_cmd_result_map[-3] = "bad value"
ui_cmd_result_map[-4] = "permission denied"
ui_cmd_result_map[-5] = "2fa needed"
ui_cmd_result_map[-6] = "2fa busy"
ui_cmd_result_map[-7] = "2fa blocked"
ui_cmd_result_map[-8] = "not processed"

Dependencies

Daily updated index of all dependencies of this script. Last update: 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
Required by	rest	api.lua	38	7.39 - 8.00	REST-API Lua-Land root for scgi_server	AVM
Required by	rest	api_generic.lua	38	7.39 - 8.00	REST-API Generic Endpoints	AVM
Required by	rest	boxname.lua (restapi)	25	7.90 - 8.00	REST-API Misc-Plugin for the FRITZ!Box-Name	AVM
Required by	rest	boxnotify_rest.lua	29	7.39 - 8.00	REST-API module for box notifications	AVM
Required by	rest	calllog_rest.lua	29	7.39 - 8.00	REST-API module for the Phone-Calls and TAM-Calls	AVM
Required by	rest	common.lua (restapi)	25	7.70 - 8.00	REST-API common helper functions	AVM
Required by	rest	configflags.lua	24	7.90 - 8.00	REST-API Plugin for the Config-Environment	AVM
Required by	rest	datatype.lua	25	7.90 - 8.00	REST-API Datatype Conversion	AVM
Required by	rest	error.lua	38	7.39 - 8.00	REST-API Error handling	AVM
Required by	rest	eventlog.lua	25	7.90 - 8.00	REST-API Plugin for the Event-Log+	AVM
Required by	rest	faxjournal_rest.lua	29	7.39 - 8.00	REST-API module for the Fax-Journal	AVM
Required by	rest	handsets.lua	25	7.90 - 8.00	TODO	AVM
Required by	rest	info.lua	24	7.90 - 8.00	REST-API Plugin for info about the REST-API	AVM
Required by	rest	internet.lua (restapi)	5	7.70	TODO	AVM
Required by	rest	isp.lua (restapi)	25	7.90 - 8.00	TODO	AVM
Required by	rest	landevice.lua	12	7.39	REST-API wrapper for the landevice ui-module	AVM
Required by	rest	locale.lua	25	7.70 - 8.00	TODO	AVM
Required by	rest	misc.lua	25	7.90 - 8.00	REST-API Plugin for dispatching Misc-Plugins	AVM
Required by	rest	monitor.lua	25	7.90 - 8.00	REST-API Plugin for the monitoring API	AVM
Required by	rest	obl_fboxname.lua	10	7.39	REST-API Demo Module	AVM
Required by	rest	phonebook.lua (restapi)	25	7.90 - 8.00	REST-API Plugin for the Phonebook	AVM
Required by	rest	phonebook_rest.lua	14	7.39 - 7.81	REST-API module for the Phonebook	AVM
Required by	rest	plugin_common.lua	25	7.90 - 8.00	REST-API Plugin helper functions	AVM
Required by	rest	privacy.lua	24	7.90 - 8.00	TODO	AVM
Required by	rest	progress.lua	25	7.70 - 8.00	TODO	AVM
Required by	rest	response.lua	38	7.39 - 8.00	REST-API Response API	AVM
Required by	rest	saveset.lua	25	7.70 - 8.00	TODO	AVM
Required by	rest	security.lua (restapi)	37	7.39 - 8.00	REST-API Security	AVM
Required by	rest	setup.lua	25	7.70 - 8.00	REST-API Plugin for dispatching Setup-Plugins	AVM
Required by	rest	smarthome.lua (restapi)	19	7.90 - 8.00	REST-API Plugin for Smarthome	AVM
Required by	rest	smarthome_rest.lua	29	7.39 - 8.00	REST-API module for Smarthome	AVM
Required by	rest	storagenasrights_rest.lua	39	7.39 - 8.00	REST-API module for NAS access permissions	AVM
Required by	rest	timermix.lua	25	7.90 - 8.00	REST-API Plugin for XML timers	AVM
Required by	rest	uimod.lua (restapi)	38	7.39 - 8.00	REST-API UI-Modules API	AVM
Required by	rest	uimod_cache.lua	25	7.70 - 8.00	TODO	AVM
Required by	rest	update.lua (restapi)	25	7.70 - 8.00	TODO	AVM
Required by	rest	validcheck.lua	25	7.70 - 8.00	REST-API common validation helper functions	AVM
Required by	rest	webusb_rest.lua	39	7.39 - 8.00	REST-API module for NAS handling	AVM
Required by	rest	wifi.lua (restapi)	5	7.70	TODO	AVM
39 dependencies for this script

Model-Matrix

Daily updated index of the presence, path and size of this script for each model. Last update: 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	1.6k - 4.0k
FRITZ!Box 4050	7.58 - 7.90	/usr/rest_api	1.6k - 4.0k
FRITZ!Box 4060	7.39 - 7.90	/usr/rest_api	1.6k - 4.0k
FRITZ!Box 5530 Fiber (main)	7.39 - 8.00	/usr/rest_api	1.6k - 4.0k
FRITZ!Box 5590 Fiber (main)	7.39 - 8.00	/usr/rest_api	1.6k - 4.0k
FRITZ!Box 5590 Fiber (prx)	7.70 - 8.00	/usr/rest_api	1.9k - 4.0k
FRITZ!Box 5690 Pro (main)	7.62	/usr/rest_api	1.6k
FRITZ!Box 6490 Cable (atom)	7.39 - 7.51	/usr/rest_api	1.6k
FRITZ!Box 6590 Cable (atom)	7.39	/usr/rest_api	1.6k
FRITZ!Box 6591 Cable (arm)	8.00	/usr/rest_api	4.0k
FRITZ!Box 6591 Cable (atom)	7.39 - 7.90	/usr/rest_api	1.4k - 4.0k
FRITZ!Box 6660 Cable (arm)	7.90 - 8.00	/usr/rest_api	4.0k
FRITZ!Box 6660 Cable (atom)	7.39 - 7.90	/usr/rest_api	1.4k - 4.0k
FRITZ!Box 6670 Cable (arm)	7.90	/usr/rest_api	4.0k
FRITZ!Box 6670 Cable (atom)	7.90	/usr/rest_api	1.6k - 4.0k
FRITZ!Box 6690 Cable (arm)	7.90	/usr/rest_api	4.0k
FRITZ!Box 6690 Cable (atom)	7.39 - 7.90	/usr/rest_api	1.5k - 4.0k
FRITZ!Box 6820 LTE v1 (main)	7.51 - 7.59	/usr/rest_api	1.6k
FRITZ!Box 6820 LTE v2 (main)	7.51 - 7.59	/usr/rest_api	1.6k
FRITZ!Box 6820 LTE v3 (main)	7.51 - 7.57	/usr/rest_api	1.6k
FRITZ!Box 6820 LTE v4	7.59	/usr/rest_api	1.6k
FRITZ!Box 6850 5G	7.39 - 7.90	/usr/rest_api	1.6k - 4.0k
FRITZ!Box 6850 LTE	7.39 - 7.90	/usr/rest_api	1.5k - 4.0k
FRITZ!Box 6890 LTE (main)	7.39 - 7.57	/usr/rest_api	1.4k - 1.6k
FRITZ!Box 6890 LTE v1 (main)	7.39 - 7.57	/usr/rest_api	1.4k - 1.6k
FRITZ!Box 6890 LTE v2 (main)	7.39 - 7.57	/usr/rest_api	1.4k - 1.6k
FRITZ!Box 7490 (main)	7.51	/usr/rest_api	1.6k
FRITZ!Box 7510	7.39 - 8.00	/usr/rest_api	1.6k - 4.0k
FRITZ!Box 7520	7.39 - 8.00	/usr/rest_api	1.6k - 4.0k
FRITZ!Box 7520 v2 (main)	7.39 - 8.00	/usr/rest_api	1.6k - 4.0k
FRITZ!Box 7530	7.39 - 8.00	/usr/rest_api	1.4k - 4.0k
FRITZ!Box 7530 AX	7.39 - 8.00	/usr/rest_api	1.5k - 4.0k
FRITZ!Box 7583 (main)	7.50 - 7.59	/usr/rest_api	1.6k
FRITZ!Box 7583 VDSL (main)	7.59 - 8.00	/usr/rest_api	1.6k - 4.0k
FRITZ!Box 7590 (main)	7.39 - 8.00	/usr/rest_api	1.4k - 4.0k
FRITZ!Box 7590 AX (main)	7.39 - 8.00	/usr/rest_api	1.4k - 4.0k
FRITZ!Box 7690	7.61 - 7.90	/usr/rest_api	1.6k - 4.0k
FRITZ!Repeater 2400	7.39	/usr/rest_api	1.4k
38 models use this script

SMW-Browser

Property:rest api const.lua

Information is currently being retrieved from the backend.