---
title: "Use the OpenSearch scroll API (https://opensearch.org/docs/latest/api-reference/scroll/) to open a scroll which will be navigated in the specified time when scroll_id is not provided, retrieve more results when a scroll_id is provided, and close a scroll when zero is the specified time."
method: POST
path: "/{index}/scroll-search"
---

# Use the OpenSearch scroll API (https://opensearch.org/docs/latest/api-reference/scroll/) to open a scroll which will be navigated in the specified time when scroll_id is not provided, retrieve more results when a scroll_id is provided, and close a scroll when zero is the specified time.

`POST /{index}/scroll-search`

## Path parameters

- `index` string, required

## Request body

- object

## Response `202`

The request has been accepted and document clearing is in process

## Other responses

- `400` — Unable to recognize scroll_open_minutes as a positive integer

## Changes

- **2025-04-02** `c727e6e09a1c` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/hubmapconsortium/apis/hubmap-search-api/changes/:index/scroll-search/post.md)

---

[API](https://skmtc.dev/hubmapconsortium/apis/hubmap-search-api.md) · [All operations](https://skmtc.dev/hubmapconsortium/apis/hubmap-search-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hubmapconsortium/hubmap-search-api/revisions/7557b0de2f46/schema)