Get build and service metadata
/
- GET
Shows basic metadata about the running logstash service. This includes build info, pipeline info and the service's status.
Query Parameters
-
wait_for_statusstring 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
timeoutquery parameter is required when you use this parameter.-
timeoutstring 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.-
prettyboolean If you append
?pretty=trueto the request, the JSON returned will be pretty formatted. Use it for debugging only!
Response
Indicates a successful call
-
hoststring -
The name of the host machine.
-
versionstring -
The version of the Logstash instance.
-
http_addressstring -
The HTTP address where the Logstash instance is accessible, including the port number.
-
idstring -
A unique identifier (uuid) for the Logstash instance.
-
namestring -
The name of the Logstash instance.
-
ephemeral_idstring -
A unique identifier for the ephemeral session of the Logstash instance.
-
snapshotbooleannullable -
statusStatus -
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:
greenredunknownyellow -
build_datestring -
The timestamp when this Logstash build was created.
-
build_shastring -
The SHA-1 hash of the Logstash build.
-
build_snapshotboolean -
Whether this Logstash build is a snapshot build.
-
pipelineobject -
workersinteger -
The number of workers in the pipeline.
-
batch_sizeinteger -
The batch size for the pipeline.
-
batch_delayinteger -
The batch delay for the pipeline.