Deployments

Create deployment

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

POST/deployments

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.

Enterprise authentication

Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.

Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.

This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.

X-blnk-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Body

namestringrequiredbody

Display name for this ledger in your workspace.

typestringrequiredbody

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

regionstringbody

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

Response

deployment_idstring

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

namestring

Display name of this ledger in your workspace.

typestring

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

tierstring

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

statusstring

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

regionstring

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

dedicatedboolean

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

ingress_modestring

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

watch_enabledboolean

Whether Watch is enabled.

usage_billing_enabledboolean

Whether usage-based billing is on for the organization.

usage_billing_enabled_attimestamp

When usage-based billing was enabled for the organization.

record_creates_blockedboolean

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_attimestamp

When the deployment was created.

updated_attimestamp

When the deployment was last updated.

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"
  }'

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

{
  "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"
}

{
  "error": "Key: 'CreateDeploymentRequest.Name' Error:Field validation for 'Name' failed on the 'required' tag"
}