Path parameters

• index string Required

  A single index or index alias that resolves to a single index.

Query parameters

• wait_for_advance boolean

  A boolean value which controls whether to wait (until the timeout) for the global checkpoints to advance past the provided checkpoints.

• wait_for_index boolean

  A boolean value which controls whether to wait (until the timeout) for the target index to exist and all primary shards be active. Can only be true when wait_for_advance is true.

• checkpoints array[number]

  A comma separated list of previous global checkpoints. When used in combination with wait_for_advance, the API will only return once the global checkpoints advances past the checkpoints. Providing an empty list will cause Elasticsearch to immediately return the current global checkpoints.

• timeout string

  Period to wait for a global checkpoints to advance past checkpoints.

  External documentation

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • global_checkpoints array[number] Required
  • timed_out boolean Required