docs/reference/winlogbeat/setup-kibana-endpoint.md
{{kib}} dashboards are loaded into {{kib}} via the {{kib}} API. This requires a {{kib}} endpoint configuration. For details on authenticating to the {{kib}} API, see Authentication.
You configure the endpoint in the setup.kibana section of the winlogbeat.yml config file.
Here is an example configuration:
setup.kibana.host: "http://localhost:5601"
You can specify the following options in the setup.kibana section of the winlogbeat.yml config file:
setup.kibana.host [_setup_kibana_host]The {{kib}} host where the dashboards will be loaded. The default is 127.0.0.1:5601. The value of host can be a URL or IP:PORT. For example: http://192.15.3.2, 192:15.3.2:5601 or http://192.15.3.2:6701/path. If no port is specified, 5601 is used.
::::{note}
When a node is defined as an IP:PORT, the scheme and path are taken from the setup.kibana.protocol and setup.kibana.path config options.
::::
IPv6 addresses must be defined using the following format: https://[2001:db8::1]:5601.
setup.kibana.protocol [kibana-protocol-option]The name of the protocol {{kib}} is reachable on. The options are: http or https. The default is http. However, if you specify a URL for host, the value of protocol is overridden by whatever scheme you specify in the URL.
Example config:
setup.kibana.host: "192.0.2.255:5601"
setup.kibana.protocol: "http"
setup.kibana.path: /kibana
setup.kibana.username [_setup_kibana_username]The basic authentication username for connecting to {{kib}}. If you don’t specify a value for this setting, Winlogbeat uses the username specified for the {{es}} output.
setup.kibana.password [_setup_kibana_password]The basic authentication password for connecting to {{kib}}. If you don’t specify a value for this setting, Winlogbeat uses the password specified for the {{es}} output.
setup.kibana.path [kibana-path-option]An HTTP path prefix that is prepended to the HTTP API calls. This is useful for the cases where {{kib}} listens behind an HTTP reverse proxy that exports the API under a custom prefix.
setup.kibana.space.id [kibana-space-id-option]The Kibana space ID to use. If specified, Winlogbeat loads {{kib}} assets into this {{kib}} space. Omit this option to use the default space.
setup.kibana.headers [_setup_kibana_headers]Custom HTTP headers to add to each request sent to {{kib}}. Example:
setup.kibana.headers:
X-My-Header: Header contents
setup.kibana.ssl.enabled [_setup_kibana_ssl_enabled]Enables Winlogbeat to use SSL settings when connecting to {{kib}} via HTTPS. If you configure Winlogbeat to connect over HTTPS, this setting defaults to true and Winlogbeat uses the default SSL settings.
Example configuration:
setup.kibana.host: "https://192.0.2.255:5601"
setup.kibana.ssl.enabled: true
setup.kibana.ssl.certificate_authorities: ["/etc/client/ca.pem"]
setup.kibana.ssl.certificate: "/etc/client/cert.pem"
setup.kibana.ssl.key: "/etc/client/cert.key
See SSL for more information.