API
API
NetObserv exposes an API which includes a Prometheus-compatible metrics endpoint and various endpoints for administrative tasks.
EF_INSTANCE_NAME
Configure the name of the collector instance.
- Default
default
EF_API_IP
The IP address on which the collector will listen for API requests.
- Default
0.0.0.0
EF_API_PORT
The port on which the collector will listen for API requests.
- Default
8080
EF_API_TLS_ENABLE
This setting is used to enable/disable TLS connections to the API endpoint.
- Valid Values
true
,false
- Default
false
EF_API_TLS_CERT_FILEPATH
The path to the certificate to use for TLS connections to the API endpoint.
- Default
''
EF_API_TLS_KEY_FILEPATH
The path to the key to use for TLS connections to the API endpoint.
- Default
''
EF_API_BASIC_AUTH_ENABLE
This setting is used to enable/disable basic authentication protection of API endpoints.
- Default
false
EF_API_BASIC_AUTH_USERNAME
The username to use when connecting to basic authentication protection of API endpoints.
- Default
''
EF_API_BASIC_AUTH_PASSWORD
The password to use when connecting to basic authentication protection of API endpoints.
- Default
''