FOformancehq
Ledgers

Save ledger metadata

Changed on

Saves metadata key-value pairs on the ledger itself. Requires ledger:WriteMetadata; ledger:write grants it under the default scope mapping. Custom scope mappings can differ.

post/v3/{ledgerName}/metadata

Request

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

Path parameters

ledgerNamestring required

Name of the ledger

Headers

Idempotency-Keystring

Idempotency key for the request

Request body

object required

Metadata key-value pairs (supports typed values)

Example request

{
  "environment": "production",
  "team": "payments",
  "region": "eu-west-1"
}

Response

Ledger metadata saved successfully

Changes

  • f5e817eca038Revision changes
    • info

      api operation id saveLedgerMetadata removed and replaced with v3SaveLedgerMetadata

  • 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