POST
Create or modify settings.
DELETE Delete settings (reset to default).
B.1.2.2 Actions
Actions are commands that do not modify settings. Actions run instantly as opposed to
background processes, see also
GET
Mapped to POST for
/rci/show
. Not applicable to other actions.
POST
Execute a command and return its output.
DELETE Not applicable.
B.1.2.3 Background processes
Background processes are instances that can be created and polled for updates. Such
processes are bound to a particular session, and cannot be accessed from anywhere else.
GET
Retrieve updates from existing process. Returns 404 if there is no such process.
POST
Create a background process.
DELETE Terminate a background process.
B.1.3 Data Format
HTTP POST requests must be submitted in a free-form JSON,
1
that is interpreted as a batch
of parameters and nested settings, depending on the data type. Conversely, HTTP GET
returns JSON data that was previously POSTed to the specified resource.
The primary data type is Object. This is unordered collection of key-value pairs, enclosed
in curly brackets
{}
. Each key must be unique within an object.
Objects can be put one into another, or be combined in arrays as detailed in
and
B.1.3.1 Parameters
String, boolean and number values of an object are interpreted as parameters of the
resource being addressed.
{
"parameter": value
}
Example B.1. Set hotspot policy
Set policy “permit” for the Home network. Refer to
to see how
“interface” and “access” parameters are mentioned in the Arguments table.
1
In compliance with RFC 7159.
Command Reference Guide — Keenetic Extra (KN-1710)
336
Appendix B HTTP API
Summary of Contents for EXTRA KN-1710
Page 2: ......
Page 6: ...Command Reference Guide Keenetic Extra KN 1710 6 Contents Overview...
Page 20: ...Command Reference Guide Keenetic Extra KN 1710 20 Chapter 1 Product Overview...
Page 26: ...Command Reference Guide Keenetic Extra KN 1710 26 Chapter 2 Introduction to the CLI...
Page 322: ...Command Reference Guide Keenetic Extra KN 1710 322 Chapter 3 Command Reference...
Page 332: ...Command Reference Guide Keenetic Extra KN 1710 332 Glossary...
Page 348: ...Command Reference Guide Keenetic Extra KN 1710 348 Appendix C SNMP MIB...