Get deployment details

Retrieve a managed Core instance by deployment_id.

GET /deployments/{deployment_id}

cURL

curl -X GET 'https://api.cloud.blnkfinance.com/deployments/deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc' \
  -H 'X-blnk-key: CLOUD_API_KEY'

200

{
  "deployment_id": "deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "my-sandbox",
  "ingress_mode": "shared",
  "dedicated": false,
  "tier": "B1.Micro",
  "type": "sandbox",
  "region": "nyc3",
  "status": "ACTIVE",
  "domain": "my-sandbox-sharespaces.deployment.blnkfinance.com",
  "url": "https://my-sandbox-sharespaces.deployment.blnkfinance.com",
  "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:19:05.954015Z",
  "updated_at": "2026-09-11T09:20:39.861066Z"
}

Use this endpoint to retrieve deployment details by deployment_id. See Managed instances to learn more.

This endpoint is only for deployments. For a connected (self-hosted) instance, connect it from the dashboard first.

The response includes instance_id. Pass that on Proxy, Filters, Data Lake, and other Cloud APIs. For the Core secret, use Get instance details.

---

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.

Path

cURL

curl -X GET 'https://api.cloud.blnkfinance.com/deployments/deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc' \
  -H 'X-blnk-key: CLOUD_API_KEY'

deployment_id · string · required

Unique id of the deployment (deploy_...). Do not pass instance_id here.

Response

200

{
  "deployment_id": "deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "my-sandbox",
  "ingress_mode": "shared",
  "dedicated": false,
  "tier": "B1.Micro",
  "type": "sandbox",
  "region": "nyc3",
  "status": "ACTIVE",
  "domain": "my-sandbox-sharespaces.deployment.blnkfinance.com",
  "url": "https://my-sandbox-sharespaces.deployment.blnkfinance.com",
  "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:19:05.954015Z",
  "updated_at": "2026-09-11T09:20:39.861066Z"
}

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.

instance_id · string

Unique id for the connected Core (instance_...). Pass it on Proxy, Filters, Data Lake, and other Cloud APIs so Cloud routes the request to this Core. Empty while the deployment is still being provisioned.

name · string

Display name of the instance in your workspace.

type · string

Deployment type: 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

Current state of the deployment: PENDING, ACTIVE, DESTROYING, DESTROYED, or FAILED. PENDING means Cloud is still provisioning. 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.

domain · string

Hostname of the Core once the instance is reachable.

url · string

HTTPS Core URL once the instance is reachable. Use this to call Core directly, with the Core secret from Get instance details.

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.