# Logstash API

> This is version `1.0` of this API documentation. Last update on Nov 2, 2026.
> When you run Logstash, it automatically captures runtime metrics that you can use to monitor the health and performance of your Logstash deployment.
> The metrics collected by Logstash include:
> 
> - Health report.
> - Hot threads.
> - Logstash node info, like pipeline settings, OS info, and JVM info.
> - Node stats, like JVM stats, process stats, event-related stats, and pipeline runtime stats.
> - Plugins info, including a list of installed plugins.
> 
> 
> The APIs that retrieve these metrics are available by default, with no extra configuration needed.
> 
> ## Documentation source and versions
> 
> This documentation is derived from the `9.5` branch of the [logstash](https://github.com/elastic/logstash) repository.
> It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).

[Documentation](https://www.elastic.co/docs/api/doc/logstash/v9.md)

OpenAPI file: https://www.elastic.co/docs/api/doc/logstash/v9.yaml

## [Servers](https://www.elastic.co/docs/api/doc/logstash/v9/servers.md)
- http://api.example.com: http://api.example.com


## Topics

### [Authentication](https://www.elastic.co/docs/api/doc/logstash/v9/authentication.md)


## Endpoints

### [Health report](https://www.elastic.co/docs/api/doc/logstash/v9/group/endpoint-health.md)

- [Get health status](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-healthreport.md)


### [Hot threads](https://www.elastic.co/docs/api/doc/logstash/v9/group/endpoint-hot-threads.md)

- [Get hot threads](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodehotthreads.md)


### [Metadata](https://www.elastic.co/docs/api/doc/logstash/v9/group/endpoint-root.md)

- [Get build and service metadata](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-root.md)


### [Node info](https://www.elastic.co/docs/api/doc/logstash/v9/group/endpoint-node-info.md)

- [Gets node-level JVM info](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodeinfojvm.md)

- [Get node-level OS info](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodeinfoos.md)

- [Get settings for pipelines](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodeinfopipelines.md)

- [Get settings for a pipeline](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodeinfopipeline.md)


### [Node stats](https://www.elastic.co/docs/api/doc/logstash/v9/group/endpoint-node-stats.md)

- [Get node statistics](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodestats.md)

- [Get events statistics](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodestatsevents.md)

- [Get flow statistics](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodestatsflow.md)

- [Get geoip databases statistics](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodestatsgeoipdownloadmanager.md)

- [Get JVM statistics](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodestatsjvm.md)

- [Get Cgroup statistics](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodestatsos.md)

- [Get statistics for pipelines](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodestatspipelines.md)

- [Get statistics for a pipeline](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodestatspipeline.md)

- [Get process statistics](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodestatsprocess.md)

- [Get config reload statistics](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodestatsreloads.md)


### [Plugins info](https://www.elastic.co/docs/api/doc/logstash/v9/group/endpoint-plugin-info.md)

- [Get plugin info](https://www.elastic.co/docs/api/doc/logstash/v9/operation/operation-nodeplugins.md)




## Other versions (branches)

- [main (llms.txt)](https://www.elastic.co/docs/api/doc/logstash/llms.txt)

[Powered by Bump.sh](https://bump.sh)
