FOformancehq
Indexes

Drop an index from a ledger

Changed on

Removes an index from a ledger. The path parameter carries the target IndexID in canonical form (e.g. metadata:TARGET_TYPE_ACCOUNT:color, tx_builtin:TX_BUILTIN_INDEX_TIMESTAMP). Requires ledger:WriteLedger scope.

The drop is idempotent. An IndexID that has no registry entry on the ledger (never created, or already dropped) also answers 204, and each committed drop appends a DROP_INDEX entry to the ledger log. A mistyped canonical id is therefore not reported; read the index with GET /v3/{ledgerName}/indexes/{canonicalId} first when the caller must know that it exists. 404 means that the ledger does not exist.

delete/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

Idempotency-Keystring

Response

Index removed, or no index with this id was registered on the ledger.

Changes

  • f5e817eca038Revision changes
    • info

      api operation id dropIndex removed and replaced with v3DropIndex

  • 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

    • info

      added the non-success response with the status