HTTP Server

http.server.api_enabled

Abbreviation

ht s a

Access

get/set

Description

Enable the HTTP Server RESTful API.

See Networking and Security, HTTP Server .

The API is enabled by default, so enabling the HTTP server with http.server.enabled also allows access to the API. To disable HTTP RESTful API calls when the HTTP server is running, set http.server.api_enabled to 0 .

Arguments

<0/1>

Default

1

Platforms

Get example 

> get http.server.api_enabled
1

Set example 

> set ht s a 0
Set OK

http.server.cors_origin

Abbreviation

ht s c

Access

get/set

Description

Specifies origins for which the web browser same-origin policy is relaxed.

If <origin> is set to an empty string, then CORS is completely disabled.

For requests without credentials, a value of * acts as a wildcard, allowing any origin to access the resource.

See HTTP Server RESTful API, CORS .

Arguments

<origin>

Default

"" (empty string). To set the http.server.cors_origin variable to the empty string, supply an argument with two double quotes: ""

Platforms

Get example 

> get http.server.cors_origin

Set example 

> set ht s c *
Set OK

http.server.enabled

Abbreviation

ht s e

Access

get/set

Description

Enable the HTTP server.

See Networking and Security, HTTP Server .

Arguments

<1/0>

Default

0

Platforms

Get example 

> get ht s e
0

Set example 

> set ht s e 1
Set OK

http.server.interface

Abbreviation

ht s i

Access

get/set

Description

Specifies the network interface used by the HTTP server.

See Networking and Security, HTTP Server .

Arguments

<default/softap/wlan>

Default

default

Platforms

Get example 

> get http.server.interface
default

Set example 

> set ht s i wlan
Set OK

http.server.max_clients

Abbreviation

ht s m

Access

get/set

Description

Specifies the maximum number of clients the HTTP server allows to connect.

Restricting connected clients may be necessary to limit memory usage. See Memory .

See Networking and Security, HTTP Server .

Arguments

<clients>

Default

3 Range: 1 - 8

Platforms

Get example 

> get http.server.max_clients
3

Set example 

> set ht s m 1
Set OK

http.server.notfound_filename

Abbreviation

ht s n

Access

get/set

Description

Specifies the filename of the web page to be displayed in the event that the HTTP server reports a 404 - not found error. <filename>

See Networking and Security, HTTP Server .

Default

''

Platforms

Get example 

> get http.server.notfound_filename

Set example 

> set ht s n notfound.html
Set OK

http.server.port

Abbreviation

ht s p

Access

get/set

Description

Set the port on which the HTTP server listens.

See Networking and Security, HTTP Server .

Arguments

<listening port>

Default

80

Platforms

Get example 

> get ht s p
80

Set example 

> set http.server.port 8080
Set OK

http.server.root_filename

Abbreviation

ht s r

Access

get/set

Description

This sets or gets the root file of the HTTP server. If a plain request to http:// is issued, with no url specified, this file is returned.

See Networking and Security, HTTP Server .

Arguments

<filename>

Default

/setup/index.html

Platforms

Get example 

> get ht s r
/setup/index.html

Set example 

> set http.server.root_filename /setup/home.html
Set OK