---
title: Get bucket index status
description: Returns the indexing progress of a bucket: counts by state, and one page of versions.
doc_version: 0.1.0-preview
last_updated: 2026-09-14
---

# Get bucket index status

`GET /v1/workspaces/{workspaceId}/buckets/{bucketId}/index-status`

Returns the indexing progress of a bucket: counts by state, and one page of versions. The default page lists the versions that are not indexed yet, in the order they will finish. Filter failed or unsupported to see why versions are not searchable. A bucket with indexing disabled fails with indexing_disabled. Role: viewer or higher.

## Authentication

Send `Authorization: Bearer <GRAPHON_API_KEY>`. Read the key from the
GRAPHON_API_KEY environment variable. Never print it.

## Path parameters

- `workspaceId` (string) — The workspace id.
- `bucketId` (string) — The bucket id.

## Query parameters

- `filter` (string (optional)) — unfinished (the default): versions that are not indexed yet, in the order they will finish. failed or unsupported: those versions, in key order. One of: unfinished, failed, unsupported.
- `prefix` (string (optional)) — Return only keys that start with this text.
- `cursor` (string (optional)) — The nextCursor from the previous page.
- `limit` (string (optional)) — The most versions to return for one page, from 1 to 1000. The default is 100.

## Example request

```bash
curl \
  --url "https://storage.beta.graphon.sh/v1/workspaces/wspq7ws2np5l8z4/buckets/bktA1b2C3d4E5/index-status" \
  --header "Authorization: Bearer $GRAPHON_API_KEY"
```

## CLI

```bash
graphon buckets index-status support-tickets
```

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.