Get bucket index status

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

Returns how far the indexing of a bucket has come: counts by state, and one page of versions. The default page is the indexing queue, in the order the versions will finish. Filter failed or unsupported to see why versions are not searchable. A bucket with indexing disabled returns 409 indexing_disabled. Role: viewer or higher.

View as Markdown

Authentication

Send your Graphon API key with every request. The value is the whole API key that Graphon showed when you created it. See Authentication.

Authorization: Bearer <GRAPHON_API_KEY>

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

Request

Loading your session…

Response

This operation does not return a response body.

Path parameters

workspaceIdstring

The workspace id.

bucketIdstring

The bucket id.

Query parameters

filterstring (optional)

unfinished (the default): versions still on their way into search, in the order they finish. failed or unsupported: those versions, in key order. One of: unfinished, failed, unsupported.

prefixstring (optional)

Return only keys that start with this text.

cursorstring (optional)

The nextCursor from the previous page.

limitstring (optional)

The most versions to return for one page, from 1 to 1000. The default is 100.

Was this page helpful?