Main Content

https

URL for secure connections

Syntax

--https host:port

Description

https specifies the interface port and the optional address or host name to use for secure client-server communication.

Starting in R2019b, if you set the https property, you must set the x509-private-key and x509-cert-chain properties; otherwise, the server fails to start.

Parameters

host

Host name or IP address of the machine running the server instance. If you do not specify the host, the server binds to any available interface.

port

Port number used by the server instance to accept connections. Bind to any available port by specifying 0.

Examples

  • For on-premises server instances created using the command line, update this server configuration property in the main_config server configuration file.

  • For on-premises server instances created using the dashboard and for server deployments in the cloud, use the dashboard and cloud dashboard, respectively, to update the server configuration property.

Configure Using Command Line

Restrict Access to HTTPS Interface for Local Clients Only on Port 9920

In the main_config file, set the https property to the following:

--https 9920
Bind to Any Free Port

In the main_config file, set the http property to the following. The bound address is written to $INSTANCE/endpoint/http.

--https 0
Bind to Specific IP Address and Port

In the main_config file, set the https property to the following:

--https 234.27.101.3:9920
Bind to Specific Host Name on Any Free Port

In the main_config file, set the https property to the following:

--https my.hostname.com:0

Configure Using Dashboard

Restrict Access to HTTPS Interface for Local Clients Only on Port 9920

In the dashboard, in the Settings tab of your server instance, under HTTP, enter the following for the HTTPS property:

9920
Bind to Any Free Port

In the dashboard, in the Settings tab of your server instance, under HTTP, enter the following for the HTTPS property:

0
Bind to Specific IP Address and Port

In the dashboard, in the Settings tab of your server instance, under HTTP, enter the following for the HTTPS property:

234.27.101.3:9920
Bind to Specific Host Name on Any Free Port

In the dashboard, in the Settings tab of your server instance, under HTTP, enter the following for the HTTPS property:

my.hostname.com:0