Page Comparison

Property

Type

Function

Uri

String

This property contains the URI of the desired endpoint. Schema and host are mandatory, the specification of a port is optional. If no port is specified, the respective default ports (80 for HTTP and 443 for HTTPS) are used. If no IP address is specified as the host, the specified name is converted to an IP address using DNS lookup. The IP addresses 0.0.0.0 or * represent all available IP addresses of the server.

Certificate

JSON object

This property is only required was used in previous versions to specify the server certificate when using HTTPS. The JSON object specified here requires the following properties:

Source
Specifies the location of the certificate. The following values are supported:

File
The certificate is available as a file.

UserStore
The certificate is located in the user-specific certificate store.

SystemStore
The certificate is located in the system-specific certificate store.

Store
The certificate is stored in a certificate store and Connect tries to determine it based on the other data.

Path
For Source "File" only: The path to the certificate file or the path to the directory containing the certificate file.

Name
Only for Source "File": If the "Path" property contains the directory that contains the certificate file, the file name of the certificate file must be specified here. Otherwise, this property can be omitted.

Password
Only for Source "File": The password for the private key contained in the certificate file.

FriendlyName (or DisplayName)
Selection criterion: The display name (friendly name) of the certificate to be used.

SerialNumber (or Serial or SerialNo)
Selection criterion: The serial number of the certificate to be used.

SubjectName (or Subject)

Selection criterion: The subject of the certificate to be used.

Thumbprint
Selection criterion: The fingerprint (thumbprint) of the certificate to be used.

The selection criteria are only evaluated if the certificate is to be read from a certificate store. Not all possible selection criteria have to be specified, but the certificate search must lead to a unique result. If several certificates meet the selection criteria, the web server cannot be started. Invalid certificates are not considered during certificate search.

The use of multiple certificates on the same endpoint is currently not supported. If an endpoint can be reached via different hostnames, these must be listed in a certificate. Wildcard certificates are supported without restrictionsFor more information on the specification of the certificates to use, see below.

This property is only supported for compatibility reasons. Please use the ServerCertificates property to specify the server certificate, which also supports the use of multiple server certificates.

ClientCertificates

JSON object

This property is only taken into account when using HTTPS and allows authentication at connection level using client certificates (mutual TLS authentication / mTLS). A detailed description can be found in a separate section below.

ServerCertificates

JSON object

This property is only required when using HTTPS and is used to specify the server certificates to use. A detailed description can be found in a separate section below.