Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Within this configuration file, general TreeApi settings are configured.

...

Parameter

Description

Scope

Unit

Default value

Host

IP or hostname for API access. Empty for all interfaces.

string

none

127.0.0.1

Port

Port for http access.

1 - 65535

TCP port

21012

SecurePort

Port for https access.

1 - 65535

TCP port

21013

HttpsOnly

If activated, only https is available.

true/false

none

False

CertificateLifeTime

Certificate lifetime (in months) for newly created certificates

12 – 65535

months

120

CertificateSubjectName

Subject name of certificate

string

none

NETx BMS Platform Tree Api

AuthType

Used authentication type (Basic or JWT).

Basic, JWT

none

Basic

JwtIssuer

JWT issuer

string

none

empty

JwtAudience

JWT audience.

string

none

empty

JwtSecret

JWT secret.

string

none

empty

JwtExpirationMinutes

JWT validity in minutes.

1 - 65535

mintues

60