Path parameters

• index string | array[string] Required

  Returns the indices and shards that a search request would be executed against.

Query parameters

• allow_no_indices boolean

  If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

• expand_wildcards string | array[string]

  Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

• ignore_unavailable boolean

  If false, the request returns an error if it targets a missing or closed index.

• local boolean

  If true, the request retrieves information from the local node only.

• preference string

  Specifies the node or shard the operation should be performed on. Random by default.

• routing string

  Custom value used to route operations to a specific shard.

Responses

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

  • nodes object Required
    Hide nodes attribute Show nodes attribute object

    • * object Additional properties

      Additional properties are allowed.

      Hide * attributes Show * attributes object

      • name string Required
      • ephemeral_id string Required
      • transport_address string Required
      • external_id string Required
      • attributes object Required

        Lists node attributes.

        Hide attributes attribute Show attributes attribute object

        • * string Additional properties
      • roles array[string] Required
        • @doc_id node-roles

        Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.

      • version string Required
      • min_index_version number Required
      • max_index_version number Required
  • shards array[array] Required
    Hide shards attributes Show shards attributes object

    • state string Required

      Values are UNASSIGNED, INITIALIZING, STARTED, or RELOCATING.

    • primary boolean Required
    • node string
    • shard number Required
    • index string Required
    • allocation_id object
      Hide allocation_id attribute Show allocation_id attribute object

      • * string
    • recovery_source object
      Hide recovery_source attribute Show recovery_source attribute object

      • * string
    • unassigned_info object

      Additional properties are allowed.

      Hide unassigned_info attributes Show unassigned_info attributes object

      • at string
      • last_allocation_status string
      • reason string Required

        Values are INDEX_CREATED, CLUSTER_RECOVERED, INDEX_REOPENED, DANGLING_INDEX_IMPORTED, NEW_INDEX_RESTORED, EXISTING_INDEX_RESTORED, REPLICA_ADDED, ALLOCATION_FAILED, NODE_LEFT, REROUTE_CANCELLED, REINITIALIZED, REALLOCATED_REPLICA, PRIMARY_FAILED, FORCED_EMPTY_PRIMARY, or MANUAL_ALLOCATION.

      • details string
      • failed_allocation_attempts number
      • delayed boolean
      • allocation_status string

    • relocating_node string | null

      One of:

      _types:NodeId string string-2 string | null
    • relocation_failure_info object

      Additional properties are allowed.

      Hide relocation_failure_info attribute Show relocation_failure_info attribute object

      • failed_attempts number Required
  • indices object Required
    Hide indices attribute Show indices attribute object

    • * object Additional properties

      Additional properties are allowed.

      Hide * attributes Show * attributes object

      • aliases array[string]
      • filter object

        Additional properties are allowed.

        External documentation