CONFIG RESTAPI UPDATE

Level

modify,maintenance

History

Appears in 5.0.1

Description

Update public API configuration

Usage

[state=<0|1>] : Enable/disable the public API service
[port=<port_object>] : Port object name
[ServerCertificate=<certificate object>] : Certificate object to be presented in sld for REST requests, if empty sld certificate will be used
[ServerName=<string>] : Identifier used to select the public API certificate during the TLS handshake.
[BruteforceState=<0|1>] : Enable/disable bruteforce protection
[NbAttempt=<unsigned int>] : Number of attempts before being banned, fails if BruteforceState=0
[NbBruteforceEntries=<unsigned int>] : Maximum number of ip/token to follow for bruteforce, fails if BruteforceState=0
[TimeoutBanned=<unsigned int>] : Ban time, fails if bruteforcestate=0
[TriesTime=<unsigned int>] : Time interval before counter reset
[MinTokenLifeSpan=[1-9125]] : Defines the minimum lifetime of public API authentication keys in days (from 1 day to 25 years (i.e. 9125 days) must be <= to MaxTokenLifeSpan)
[MaxTokenLifeSpan=[1-9125]] : Defines the minimum lifetime of public API authentication keys in days (from 1 day to 25 years (i.e. 9125 days) must be >= MinTokenLifeSpan)
[TraceAllRoutes=<0|1>] : Forces logs of all routes if enabled.
[TraceFailedAuth=<0|1>] : Enables/disables the logging of failed authentications.

Returns

Error code

Example

CONFIG RESTAPI UPDATE state=1 port=https