Proxy API

POST

proxy

{path}

curl -X POST "https://api.cloud.blnkfinance.com/proxy/ledgers?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Integration Ledger",
    "meta_data": {
      "description": "Ledger for integration test"
    }
  }'

curl -X GET "https://api.cloud.blnkfinance.com/proxy/ledgers/ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN"

curl -X PUT "https://api.cloud.blnkfinance.com/proxy/ledgers/ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Customer Savings Ledger"
  }'

curl -X DELETE "https://api.cloud.blnkfinance.com/proxy/reconciliation/matching-rules/rule_6e6feddd-930b-4e13-8ba1-1a3eee659bb3?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN"

{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "My Integration Ledger",
  "created_at": "2024-02-20T05:28:03.558281542Z",
  "meta_data": {
    "description": "Ledger for integration test"
  }
}

{
  "error": "instance_id is required"
}

The Proxy API forwards Core HTTP requests through Blnk Cloud. Anything you can do against Core, you can do through Cloud: GET, POST, PUT, DELETE, and every other Core method and path. Send the same HTTP method, path, and body you would send to Core. Prefix the path with /proxy, authenticate with Cloud, and add instance_id. Cloud forwards the request to the target instance and returns the Core response unchanged.

For reporting and audits over historical data, use Create new query. Cloud-native APIs such as alerts and deployments are not Core routes; call them on their own Cloud paths, not through /proxy.

How it works

Your app sends the request to https://api.cloud.blnkfinance.com/proxy/... with the same HTTP method you would use on Core.
Cloud authenticates it with your Cloud API key or OAuth access token.
Cloud uses instance_id to pick the target Core instance.
Cloud forwards the request to Core.
Cloud returns the Core response unchanged.

Request and response bodies match the corresponding Core API. Use the Core docs for field shapes, then send the same payload to the Cloud Proxy URL with Cloud auth and instance_id.

Base URLs

Core:   {METHOD} http://CORE_INSTANCE_URL/{path}
Proxy:  {METHOD} https://api.cloud.blnkfinance.com/proxy/{path}?instance_id=YOUR_INSTANCE_ID

Authorization

Blnk Cloud APIs support any one of the following authentication methods. All of them work with your CLOUD_API_KEY or OAUTH_ACCESS_TOKEN. Pass X-blnk-key: CLOUD_API_KEY or X-blnk-key: OAUTH_ACCESS_TOKEN.

string

required

Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

URL format and headers

curl -X POST "https://api.cloud.blnkfinance.com/proxy/ledgers?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Integration Ledger",
    "meta_data": {
      "description": "Ledger for integration test"
    }
  }'

curl -X GET "https://api.cloud.blnkfinance.com/proxy/ledgers/ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN"

curl -X PUT "https://api.cloud.blnkfinance.com/proxy/ledgers/ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Customer Savings Ledger"
  }'

curl -X DELETE "https://api.cloud.blnkfinance.com/proxy/reconciliation/matching-rules/rule_6e6feddd-930b-4e13-8ba1-1a3eee659bb3?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN"

string

required

Core path after /proxy. Use the same path you would call on Core. See Core API reference.

string

required

Unique identifier of the Blnk Core instance to target. Required on every Proxy API request. Get it from get instance details (instance_...), not from deployment_id.

string

Required for requests with a body. Set to application/json. Use multipart/form-data for reconciliation file uploads.

Calling Core endpoints

Prefix the Core path with /proxy and keep the HTTP method. Append ?instance_id=YOUR_INSTANCE_ID to every request. All paths are relative to https://api.cloud.blnkfinance.com.

Method	Core path	Proxy path
GET	`/ledgers`	`/proxy/ledgers`
GET	`/ledgers/{id}`	`/proxy/ledgers/{id}`
POST	`/ledgers`	`/proxy/ledgers`
PUT	`/ledgers/{id}`	`/proxy/ledgers/{id}`
DELETE	`/reconciliation/matching-rules/{id}`	`/proxy/reconciliation/matching-rules/{id}`

These rows are examples. Every Core route works the same way. See the Core API reference for the full list of methods, paths, and request bodies.

When creating a transaction, Blnk Cloud automatically adds precision: 100 and a reference value if they are omitted from the request body.

Response

When Cloud can reach Core, Proxy responses pass through unchanged. Status codes and body shapes match the corresponding Core endpoint. Cloud itself returns a JSON error if instance_id is missing.

{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "My Integration Ledger",
  "created_at": "2024-02-20T05:28:03.558281542Z",
  "meta_data": {
    "description": "Ledger for integration test"
  }
}

{
  "error": "instance_id is required"
}

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.

curl -X POST "https://api.cloud.blnkfinance.com/proxy/ledgers?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Integration Ledger",
    "meta_data": {
      "description": "Ledger for integration test"
    }
  }'

curl -X GET "https://api.cloud.blnkfinance.com/proxy/ledgers/ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN"

curl -X PUT "https://api.cloud.blnkfinance.com/proxy/ledgers/ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Customer Savings Ledger"
  }'

curl -X DELETE "https://api.cloud.blnkfinance.com/proxy/reconciliation/matching-rules/rule_6e6feddd-930b-4e13-8ba1-1a3eee659bb3?instance_id=YOUR_INSTANCE_ID" \
  -H "X-blnk-key: OAUTH_ACCESS_TOKEN"

{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "My Integration Ledger",
  "created_at": "2024-02-20T05:28:03.558281542Z",
  "meta_data": {
    "description": "Ledger for integration test"
  }
}

{
  "error": "instance_id is required"
}

Start Here

Deployments

Proxy & data

Data lake

AI integrations

Audit

Alerts

Billing

How it works

Authorization

URL format and headers

Calling Core endpoints

Response

Need help?

​How it works

​Authorization

​URL format and headers

​Calling Core endpoints

​Response

​Need help?

How it works

Authorization

URL format and headers

Calling Core endpoints

Response

Need help?