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:

addr: 192.168.0.5

Listening address for the REST server. If omitted, defaults to 0.0.0.0, which accepts connections on all network interfaces. For security, it is recommended to specify a specific IP address to restrict access.

port: 8083

Port number for the embedded REST server.

http_realm: "WebAPI"

HTTP authentication realm (up to 15 characters).

http_username: "user"

HTTP authentication username (up to 15 characters).

http_password: "pass"

HTTP authentication password (up to 31 characters).

ssl_params: {...}

REST-specific SSL settings. These parameters override the global ssl_params configuration. If this section is omitted, the global SSL settings are used. Note: ca_path and ca_file are only allowed in the global ssl_params section.