Executes an Elasticsearch DSL query JSON via POST and returns hits that match the query.

Changed on Apr 2, 2025

To execute a query, the POST method must provide 1) a request body that specifies an Elasticsearch Query DSL statement 2) a bearer token in the Authorization header supplied by HuBMAP. Results are limited to those authorized by the bearer token. Uses the <strong>entities</strong> index by default.

post/search

Request

Base URL
https://search.api.hubmapconsortium.org/v3
Auth
none declared

Query parameters

produce-clt-manifeststring

An optional parameter that, when set to "true", will make the endpoint return a text representation of a manifest file that corresponds with the datasets queried rather than the original response

Request body

object required

Response

Returns search hits from backend Elasticsearch that match the query defined in the request JSON