FOformancehq
Indexes

List bucket-wide indexes

Changed on

Streams the bucket-scoped index registry. The scope query parameter selects the flavor: all (default, matches the ListIndexesRequest proto default) streams every entry across ledgers, skipping orphan entries whose owning ledger no longer exists; bucket surfaces only bucket-scoped entries (empty ledger, e.g. audit indexes). Use GET /v3/{ledgerName}/indexes for the per-ledger view. Requires ledger:ReadOps scope.

get/v3/_/indexes

Request

  • Base URL
    http://localhost:9000
  • URL
    http://localhost:9000/v3/_/indexes
  • Auth
    • HTTP bearer
    • or none

Query parameters

scope'all' | 'bucket'

Headers

X-Consistency'linearizable' | 'stale'

Read consistency. linearizable (the default) runs a Raft ReadIndex barrier and waits for the receiving node to apply up to it. stale serves the read from the receiving node's own store, with no barrier and no forwarding to the leader, so the answer may lag the leader. Matching ignores case and surrounding whitespace. An unknown value, or a repeated or comma-joined header, returns 400 INVALID_REQUEST on every /v3 route, writes included; a valid value has no effect on writes. The gRPC equivalent is the x-consistency request metadata.

Response

Indexes retrieved successfully.

dataobject[] required

Changes

  • f5e817eca038Revision changes
    • info

      api operation id listBucketIndexes removed and replaced with v3ListBucketIndexes

  • 3da23d327316Revision changes
    • info

      added the media type text/plain for the response with the status

    • info

      added the media type text/plain for the response with the status