Get deployment

GET

deployments

{id}

curl -X GET 'https://api.cloud.blnkfinance.com/deployments/deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc' \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "deployment_id": "deploy_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",
  "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:19:05.954015Z",
  "updated_at": "2026-09-11T09:20:39.861066Z"
}

{
  "error": "Deployment not found"
}

Retrieve a deployment by ID.

Path

curl -X GET 'https://api.cloud.blnkfinance.com/deployments/deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc' \
  -H 'Authorization: Bearer YOUR_API_KEY'

string

required

Unique identifier of the deployment to retrieve.

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": "ACTIVE",
  "domain": "my-sandbox-sharespaces.deployment.blnkfinance.com",
  "url": "https://my-sandbox-sharespaces.deployment.blnkfinance.com",
  "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:19:05.954015Z",
  "updated_at": "2026-09-11T09:20:39.861066Z"
}

{
  "error": "Deployment not found"
}

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, ACTIVE, DESTROYING, DESTROYED, or FAILED.

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.

string

Hostname once the instance is reachable. Omitted while PENDING.

string

HTTPS Core URL once the instance is reachable. Omitted while PENDING.

boolean

Whether database access is enabled on this deployment.

boolean

Whether Watch is enabled. When true, Watch fields such as watch_status and watch_git_repo may also be present.

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

When the instance last hit its included record allowance. Present only in that case.

array

Inbound IP allow list, when configured.

string

Present on some FAILED or DESTROYED rows.

timestamp

Set when destroy starts.

timestamp

required

When the deployment was created.

timestamp

required

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.

curl -X GET 'https://api.cloud.blnkfinance.com/deployments/deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc' \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "deployment_id": "deploy_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",
  "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:19:05.954015Z",
  "updated_at": "2026-09-11T09:20:39.861066Z"
}

{
  "error": "Deployment not found"
}

Start Here

Authentication

Deployments

Billing

Audit

Proxy & Data

Alerts

Integrations

Path

Response

Need help?

​Path

​Response

​Need help?

Path

Response

Need help?