Get build and service metadata

Shows basic metadata about the running logstash service. This includes build info, pipeline info and the service's status.

Query parameters

wait_for_status string: Wait (until the timeout expires) for the service changes to a specific health status (or a better status). A green status is better than yellow and yellow is better than red. The timeout query parameter is required when you use this parameter.
timeout string: Period to wait for the status to reach the requested target status. Must be an integer with units, for example 3s. If the target status is not reached before the timeout expires, the request returns status code 408.
pretty boolean: If you append ?pretty=true to the request, the JSON returned will be pretty formatted. Use it for debugging only!

Indicates a successful call

application/json

host string: The name of the host machine.
version string: The version of the Logstash instance.
http_address string: The HTTP address where the Logstash instance is accessible, including the port number.
id string: A unique identifier (uuid) for the Logstash instance.
name string: The name of the Logstash instance.
ephemeral_id string: A unique identifier for the ephemeral session of the Logstash instance.
snapshot boolean nullable
status enum: Health status of Logstash, based on the aggregated status of all indicators. Statuses are:

green: Logstash is healthy.

unknown: Logstash health could not be determined.

yellow: The functionality of Logstash is in a degraded state and may need remediation to avoid the health becoming red.

red: Logstash is experiencing an outage or certain features are unavailable for use.; Values: green red unknown yellow
build_date string: The timestamp when this Logstash build was created.
build_sha string: The SHA-1 hash of the Logstash build.
build_snapshot boolean: Whether this Logstash build is a snapshot build.
pipeline object