FOformancehq
Indexes

Get a single index registry entry

Changed on

Returns the Index registry entry (id, ledger, createdAt, forwardEncodingVersion) for a single index, serialized in protobuf-JSON camelCase. Requires ledger:ReadLedger scope.

get/v3/{ledgerName}/indexes/{canonicalId}

Request

  • Base URL
    http://localhost:9000
  • URL
    http://localhost:9000/v3/{ledgerName}/indexes/{canonicalId}
  • Auth
    • HTTP bearer
    • or none

Path parameters

ledgerNamestring required

Name of the ledger

canonicalIdstring required

Canonical form of the target IndexID.

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

Index retrieved successfully.

dataobject required

Index (protobuf JSON representation)

Changes

  • f5e817eca038Revision changes
    • info

      api operation id getIndex removed and replaced with v3GetIndex

  • 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