Query parameters

  • allow_no_indicesboolean

    Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

  • expand_wildcardsstring | array[string]

    Whether to expand wildcard expression to concrete indices that are open, closed or both.

    Supported values include:

    • all: Match any data stream or index, including hidden ones.
    • open: Match open, non-hidden indices. Also matches any non-hidden data stream.
    • closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
    • hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
    • none: Wildcard expressions are not accepted.

    Values are all, open, closed, hidden, or none.

  • flat_settingsboolean

    Return settings in flat format (default: false)

  • ignore_unavailableboolean

    Whether specified concrete indices should be ignored when unavailable (missing or closed)

  • localboolean

    Return local information, do not retrieve the state from master node (default: false)

  • master_timeoutstring

    Specify timeout for connection to master

    Values are -1 or 0.

  • wait_for_metadata_versionnumber

    Wait for the metadata version to be equal or greater than the specified metadata version

  • wait_for_timeoutstring

    The maximum time to wait for wait_for_metadata_version before timing out

    Values are -1 or 0.

Responses

  • 200 application/json
GET /_cluster/state
curl \
 --request GET 'http://api.example.com/_cluster/state' \
 --header "Authorization: $API_KEY"