Authorization
If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>
.
Replace <api-key>
with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.
See also: Secure your Blnk server
Body
Name of the ledger. Ensure it is as descriptive as possible for easy reference.
Additional metadata for the request body.
Response
Unique id to represent the created ledger.
Indicates the date & time of creation.
Additional metadata of the ledger.
curl --request POST \
--url http://localhost:5001/ledgers \
--header 'X-blnk-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Customer Savings Ledger",
"meta_data": {
"project_owner": "Acme LLC",
"description": "For all savings account created & managed by Acme."
}
}'
{
"ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"name": "Customer Savings Ledger",
"created_at": "2024-02-20T05:28:03.558281542Z",
"meta_data": {
"project_owner": "Acme LLC",
"description": "For all savings account created & managed by Acme."
}
}
Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool.
To ask questions or discuss issues, please contact us or join our Discord community.