Get bucket 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.

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

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 that are not indexed yet, in the order they will 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?

View as Markdown