[api] section¶
API configuration.
listen¶
API listen address in form <address>:<port>, where <address> is one of:
auto- use hostname to detect address.- interface name, like
eth0 -
IP address.
-
Default value:
auto:0 - YAML Path:
api.listen - Key-value Path:
api/listen - Environment:
NOC_API_LISTEN
The former listen parameter is deprecated and will be removed in NOC 27.
Use api.listen in YAML configuration and NOC_API_LISTEN in environment
configuration. listen and NOC_LISTEN remain available during the
deprecation period.
backlog¶
Maximum number of pending connections in the listener queue.
- Default value:
2048 - YAML Path:
api.backlog - Key-value Path:
api/backlog - Environment:
NOC_API_BACKLOG
http_version¶
HTTP protocol mode accepted by the API server:
AUTOaccepts HTTP/1.1 and HTTP/2.HTTP_1_1accepts only HTTP/1.1.-
HTTP_2accepts only HTTP/2. On a cleartext listener, clients must use h2c prior knowledge. -
Default value:
AUTO -
Possible values:
AUTOHTTP_1_1HTTP_2
-
YAML Path:
api.http_version - Key-value Path:
api/http_version - Environment:
NOC_API_HTTP_VERSION