GET /
Basic auth

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!

Responses

  • 200 application/json

    Indicates a successful call

    Hide response attributes Show response attributes object
    • 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 | null
    • status string

      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 are green, red, unknown, or 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
      Hide pipeline attributes Show pipeline attributes object
      • workers integer

        The number of workers in the pipeline.

      • batch_size integer

        The batch size for the pipeline.

      • batch_delay integer

        The batch delay for the pipeline.
GET / 
curl \
 --request GET 'http://api.example.com/' \
 --user "username:password"
Response examples (200) 
{
  "id": "58df6f7c-eb5c-5d42-bc20-c7b22779aa12",
  "host": "logstash-pipelines.example.com",
  "name": "logstash-pipelines",
  "status": "green",
  "version": "9.2.1",
  "pipeline": {
    "workers": 10,
    "batch_size": 125,
    "batch_delay": 50
  },
  "snapshot": true,
  "build_sha": "ff3e87d66f10c05a74d0cef7bc2911d60cee1ebc",
  "build_date": "2025-11-20T01:18:55+00:00",
  "ephemeral_id": "59df6f6c-eb5c-4d42-bc20-c7b44779aa12",
  "http_address": "127.0.0.1:9600",
  "build_snapshot": true
}