ToC path:

xSQL Web Services REST Parameters

The xSQL configuration file can be used to run the embedded REST server and expose the Web Services REST API.

For an overview see page Configuration File Parameters

The rest section consists of a set of "name : value" pairs enclosed within braces. For example:
 
    rest : {
        addr : 192.168.0.5, 
        port : 8083, 
 
        # HTTP basic authentication parameters. Authentication is disabled
        # if these parameters are not set.
        http_realm: "WebAPI",
        http_username: "user",
        http_password: "pass",
 
        # REST-specific SSL settings. See the global ssl_params section
        # for the description of the parameters and their default values.
        # These parameters override the global settings.
        # To inherit the global ssl_params settings, leave the ssl_params section empty.
        ssl_params : {
            cipher_list : "HIGH:!aNULL:!kRSA:!PSK:!SRP:!MD5:!RC4",
            max_cert_list : 102400,
            verify_mode : [verify_none],
            verify_depth : 100,
            cert_file_pem : "restcert.pem",
            pkey_file_pem : "restkey.pem"
        },
    },
    ... 
     
The following table lists the possible options for the rest section:

Option name : example value Comment

addr : 192.168.0.5, Set the listening address. If omitted, this parameter defaults to 0.0.0.0 which causes the REST server to accept incoming connections on all network interfaces (LAN, WiFi, whatever is installed). This default behavior can be undesirable or even dangerous. To restrict network access any valid IP address may be specified.

port : 8083, Set port for embedded REST server

http_realm: "WebAPI", The authentication realm (up to 15 characters)

http_username: "user", Authentication username (up to 15 characters)

http_password: "pass", Authentication password (up to 31 characters)

ssl_params : {...} REST-specific SSL settings. See the global ssl_params section for the description of the parameters and their default values. These parameters override the global settings. Global ssl_params settings are used if this section is omitted. (They have the same parameters and default values as the global section, except for ca_path and ca_file, which are only allowed in the global section.)

Option name : example value	Comment
addr : 192.168.0.5,	Set the listening address. If omitted, this parameter defaults to `0.0.0.0` which causes the REST server to accept incoming connections on all network interfaces (LAN, WiFi, whatever is installed). This default behavior can be undesirable or even dangerous. To restrict network access any valid IP address may be specified.
port : 8083,	Set port for embedded REST server
http_realm: "WebAPI",	The authentication realm (up to 15 characters)
http_username: "user",	Authentication username (up to 15 characters)
http_password: "pass",	Authentication password (up to 31 characters)
ssl_params : {...}	REST-specific SSL settings. See the global `ssl_params` section for the description of the parameters and their default values. These parameters override the global settings. Global `ssl_params` settings are used if this section is omitted. (They have the same parameters and default values as the global section, except for `ca_path` and `ca_file`, which are only allowed in the global section.)