Start here

Core API key

Send a Core API key on requests to your Blnk Core instance.

A Core API key authenticates a request to your Blnk Core instance. Send it in the X-blnk-key header. The host is that instance. A local install uses http://localhost:5001.

Core issues this key. An Enterprise API key is a different credential, issued by the Cloud or Enterprise workspace.

How it works

Turn on secure mode and set server.secret_key. That value is the master key. It can call every endpoint, so use it for setup. For service traffic, create a scoped key and send that instead.

The full setup is in Secure your Blnk server and Scoped API keys.

With secure mode off, Core does not require a key.

curl -X GET "http://localhost:5001/ledgers" \
  -H "X-blnk-key: <api-key>"

Replace <api-key> with the master key or a scoped key. Keep it off the client and out of public repositories.