Create deployment

Deploy a ledger as a managed Core instance through Blnk Cloud.

POST /deployments

Sandbox

curl -X POST 'https://api.cloud.blnkfinance.com/deployments' \
  -H 'X-blnk-key: CLOUD_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "my-sandbox",
    "type": "sandbox"
  }'

201

{
  "deployment_id": "deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "my-sandbox",
  "ingress_mode": "shared",
  "dedicated": false,
  "tier": "B1.Micro",
  "type": "sandbox",
  "region": "nyc3",
  "status": "PENDING",
  "watch_enabled": false,
  "usage_billing_enabled": true,
  "usage_billing_enabled_at": "2026-09-09T07:20:08.028229Z",
  "record_creates_blocked": false,
  "created_at": "2026-09-11T09:28:16.864765Z",
  "updated_at": "2026-09-11T09:28:16.864765Z"
}

Use this endpoint to deploy a ledger. Cloud hosts a managed Core instance and connects it to your workspace, so you get a live ledger over the API without installing or operating Core yourself.

If you already run Core, this is the same action as Deploy an instance in the dashboard.

This endpoint deploys a managed ledger only. To attach a self-hosted Core instead, connect it from the dashboard first.

---

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.

X-blnk-key · string · required

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

Body

Sandbox

curl -X POST 'https://api.cloud.blnkfinance.com/deployments' \
  -H 'X-blnk-key: CLOUD_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "my-sandbox",
    "type": "sandbox"
  }'

name · string · required

Display name for this ledger in your workspace.

type · string · required

Environment for the ledger: sandbox or production. Cloud assigns capacity from this value.

region · string

Production only. Choose a datacenter closest to your app. Do not send this for sandbox. Cloud assigns the sandbox region.

Response

201

{
  "deployment_id": "deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "my-sandbox",
  "ingress_mode": "shared",
  "dedicated": false,
  "tier": "B1.Micro",
  "type": "sandbox",
  "region": "nyc3",
  "status": "PENDING",
  "watch_enabled": false,
  "usage_billing_enabled": true,
  "usage_billing_enabled_at": "2026-09-09T07:20:08.028229Z",
  "record_creates_blocked": false,
  "created_at": "2026-09-11T09:28:16.864765Z",
  "updated_at": "2026-09-11T09:28:16.864765Z"
}

deployment_id · string

Unique id for this managed deployment (deploy_...). Use it with Deployments APIs. Do not pass it as instance_id when routing Cloud APIs.

name · string

Display name of this ledger in your workspace.

type · string

Environment for the ledger: sandbox or production. Cloud assigns capacity from this value.

tier · string

Capacity Cloud assigned for this deployment, such as B1.Micro or B1.Standard. You do not choose this when you create the deployment.

status · string

PENDING until the instance is ready, then ACTIVE. Sandbox typically takes 7 - 10 minutes. Production can take 10 - 30 minutes.

region · string

Datacenter code for the instance. Cloud assigns this for sandbox. You choose it for production.

dedicated · boolean

true when the instance runs on dedicated Production infrastructure. Sandbox is always false.

ingress_mode · string

How Cloud routes traffic to the instance. Live values include shared and legacy.

watch_enabled · boolean

Whether Watch is enabled.

usage_billing_enabled · boolean

Whether usage-based billing is on for the organization.

usage_billing_enabled_at · timestamp

When usage-based billing was enabled for the organization.

record_creates_blocked · boolean

true when this instance has used its included records and organization usage-based billing is off, so new records cannot be created. false while the instance is within its allowance or usage-based billing is on. See Usage-based billing.

created_at · timestamp

When the deployment was created.

updated_at · timestamp

When the deployment was last updated.

---

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.