HTTP Hosting Endpoints Configuration
Configure the endpoints of the PowerTSM HTTP API web service.
The Endpoints element is a container for individual endpoint configurations. Each endpoint you define becomes a named entry point where the HTTP API can accept requests.
This element replaces the deprecated Urls element and provides more flexibility by allowing you to configure SSL certificates, protocols, and other settings for each endpoint individually.
Use the {EndpointName} element to define a named endpoint. The element name becomes the identifier for the endpoint.
Configuration Path
Section titled “Configuration Path”HAKOM:TSM:Http:Hosting:Endpoints:{EndpointName}Configuration Structure
Section titled “Configuration Structure”{EndpointName}├─ Url├─ Protocols├─ SslProtocols├─ ClientCertificateMode├─ Sni│ └─ {HostName}│ ├─ Protocols│ ├─ SslProtocols│ ├─ Certificate│ └─ ClientCertificateMode└─ Certificate ├─ Path ├─ Password ├─ Location ├─ Store ├─ Subject └─ AllowInvalidQuick Start
Section titled “Quick Start”Each endpoint is defined by creating a child element under Endpoints. The name you choose for this element (e.g., <DefaultEndpoint>, <SecureEndpoint>) becomes the identifier for that endpoint.
Define multiple endpoints with different purposes:
<HAKOM> <TSM> <Http> <Hosting> <Endpoints> <DefaultEndpoint> <Url>http://localhost:8080</Url> </DefaultEndpoint> <SecureEndpoint> <Url>https://localhost:8443</Url> <Certificate> <Path>C:\certificates\server.pfx</Path> <Password>mypassword</Password> </Certificate> </SecureEndpoint> <PublicEndpoint> <Url>https://api.example.com:443</Url> <Certificate> <Location>LocalMachine</Location> <Store>My</Store> <Subject>api.example.com</Subject> </Certificate> </PublicEndpoint> </Endpoints> </Hosting> </Http> </TSM></HAKOM>This configuration creates three separate endpoints:
DefaultEndpoint: Listens for HTTP traffic on port 8080SecureEndpoint: Listens for HTTPS traffic on port 8443PublicEndpoint: Listens for HTTPS traffic on port 443
Configuration Elements
Section titled “Configuration Elements”| Element | Type | Default | Required | Description |
|---|---|---|---|---|
Url |
string |
— | ✓ | The URL where the endpoint will listen for requests. |
Protocols |
enum |
— | The HTTP protocols supported by this endpoint. See Protocols below. | |
SslProtocols |
enum |
— | The TLS/SSL protocols allowed for this endpoint. See SSL Protocols below. | |
ClientCertificateMode |
enum |
NoCertificate |
Configures client certificate requirements. See Client Certificate Mode below. | |
Sni |
object |
— | Configures Server Name Indication for host-specific settings. See SNI Configuration below. | |
Certificate |
object |
— | Secures the endpoint with an SSL X.509 certificate. See HTTP Hosting Endpoint Certificate Configuration for details. |
Protocols
Section titled “Protocols”Specify which HTTP protocols the endpoint supports.
| Value | Description |
|---|---|
Http1 |
HTTP/1.1 only. |
Http2 |
HTTP/2 only. |
Http3 |
HTTP/3 only (requires HTTPS) (not supported/experimental). |
Http1AndHttp2 |
Both HTTP/1.1 and HTTP/2 (default for HTTPS endpoints). |
Http1AndHttp2AndHttp3 |
HTTP/1.1, HTTP/2 and HTTP/3 (not supported/experimental). |
SSL Protocols
Section titled “SSL Protocols”Specify which TLS/SSL protocol versions are allowed. This is only applicable to HTTPS endpoints.
| Value | Description |
|---|---|
Tls |
TLS 1.0 (not recommended). |
Tls11 |
TLS 1.1 (not recommended). |
Tls12 |
TLS 1.2. |
Tls13 |
TLS 1.3. |
None |
No specific protocol requirement (use system default). |
Multiple protocols can be combined using the pipe (|) symbol.
Client Certificate Mode
Section titled “Client Certificate Mode”Configure how the endpoint handles client certificates for mutual TLS (mTLS) authentication.
| Value | Description |
|---|---|
NoCertificate |
Client certificates are not used (default). |
AllowCertificate |
Client certificates are accepted but not required. |
RequireCertificate |
Client certificates are required for all connections. |
DelayCertificate |
Client certificate validation is deferred until after the TLS handshake. |
SNI Configuration
Section titled “SNI Configuration”Server Name Indication (SNI) allows you to configure different certificates and settings for different hostnames on the same endpoint.
See HTTP Hosting Endpoint SNI Configuration.
Examples
Section titled “Examples”Basic HTTP endpoint
Section titled “ Basic HTTP endpoint”Configure an endpoint named DefaultEndpoint that listens on port 8080:
<DefaultEndpoint> <Url>http://localhost:8080</Url></DefaultEndpoint>HTTPS endpoint with certificate
Section titled “ HTTPS endpoint with certificate”Configure a secure endpoint named SecureEndpoint that uses HTTPS:
<SecureEndpoint> <Url>https://localhost:8443</Url> <Certificate> <Path>C:\certificates\my_certificate.pfx</Path> <Password>mypassword</Password> </Certificate></SecureEndpoint>Modern HTTPS endpoint with HTTP/2 and HTTP/3
Section titled “ Modern HTTPS endpoint with HTTP/2 and HTTP/3”Configure an endpoint with modern HTTP protocols and TLS 1.3:
<ModernEndpoint> <Url>https://localhost:5001</Url> <Protocols>Http1AndHttp2AndHttp3</Protocols> <SslProtocols>Tls12|Tls13</SslProtocols> <Certificate> <Path>C:\certificates\server.pfx</Path> <Password>mypassword</Password> </Certificate></ModernEndpoint>Endpoint with client certificate requirement
Section titled “ Endpoint with client certificate requirement”Configure an endpoint that requires client certificates for mutual TLS authentication:
<SecureApiEndpoint> <Url>https://localhost:5001</Url> <Protocols>Http1AndHttp2</Protocols> <SslProtocols>Tls12|Tls13</SslProtocols> <ClientCertificateMode>RequireCertificate</ClientCertificateMode> <Certificate> <Location>LocalMachine</Location> <Store>My</Store> <Subject>api.example.com</Subject> </Certificate></SecureApiEndpoint>Development endpoint with self-signed certificate
Section titled “ Development endpoint with self-signed certificate”Configure a development endpoint with a self-signed certificate:
<DevelopmentEndpoint> <Url>https://localhost:5001</Url> <Protocols>Http1AndHttp2</Protocols> <Certificate> <Location>CurrentUser</Location> <Store>My</Store> <Subject>localhost</Subject> <AllowInvalid>true</AllowInvalid> </Certificate></DevelopmentEndpoint>