Get a ledger

GET /api/ledger/v2/{ledger}

Try it

Get a ledger

cURL

curl --request GET \
  --url http://localhost/api/ledger/v2/{ledger} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "name": "<string>",
    "addedAt": "2023-11-07T05:31:56Z",
    "bucket": "<string>",
    "metadata": {
      "admin": "true"
    },
    "features": {},
    "id": 123
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

ledger · string · required

Name of the ledger.

Example:

"ledger001"

Response

200

application/json

OK

data · object · required

Show child attributes

data. name · string · required

data. addedAt · string<date-time> · required

data. bucket · string · required

data. metadata · object

Show child attributes

data.metadata. {key} · string

Example:

{ "admin": "true" }

data. features · object

Show child attributes

data.features. {key} · string

data. id · integer