Create deployment

POST

deployments

curl -X POST 'https://api.cloud.blnkfinance.com/deployments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "my-sandbox",
    "tier": "B1.Micro",
    "type": "sandbox"
  }'

{
  "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",
  "has_db_access": false,
  "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"
}

Create a managed Core instance programmatically.

Body

curl -X POST 'https://api.cloud.blnkfinance.com/deployments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "my-sandbox",
    "tier": "B1.Micro",
    "type": "sandbox"
  }'

string

required

Display name for the instance.

string

required

Capacity tier. Sandbox uses B1.Micro. Production typically uses B1.Standard.

string

Deployment type: sandbox or production.

string

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

Response

{
  "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",
  "has_db_access": false,
  "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"
}

string

required

Unique identifier for the deployment.

string

required

Instance name.

string

required

sandbox or production.

string

required

Capacity tier, such as B1.Micro or B1.Standard.

string

required

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

string

Datacenter code for the instance.

boolean

true for dedicated (Production) infrastructure.

string

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

boolean

Whether database access is enabled on this deployment.

boolean

Whether Watch is enabled.

boolean

Whether usage-based billing is on for the workspace.

timestamp

When usage-based billing was enabled.

boolean

true when the instance cannot create new records.

timestamp

required

When the deployment was created.

timestamp

required

When the deployment was last updated.

Poll Get deployment until status is ACTIVE. Then url and domain are present.

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/deployments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "my-sandbox",
    "tier": "B1.Micro",
    "type": "sandbox"
  }'

{
  "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",
  "has_db_access": false,
  "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"
}

Start Here

Authentication

Deployments

Billing

Audit

Proxy & Data

Alerts

Integrations

Body

Response

Need help?

​Body

​Response

​Need help?

Body

Response

Need help?