List instances

GET

instances

curl -X GET 'https://api.cloud.blnkfinance.com/instances' \
  -H 'Authorization: Bearer YOUR_API_KEY'

[
  {
    "instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "ledger_instance_id": "",
    "name": "my-sandbox",
    "sync_status": "connected",
    "ledger_version": "",
    "connection_type": "agent",
    "instance_url": "https://my-sandbox-sharespaces.deployment.blnkfinance.com",
    "type": "cloud",
    "deployment_id": "deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "created_at": "2026-09-14T11:32:14.112322Z",
    "monitoring_enabled": true,
    "deployment": {
      "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",
      "has_db_access": false,
      "watch_enabled": false,
      "current_step": "FINALIZED",
      "operation_type": "deploy",
      "created_at": "2026-09-14T11:32:11.971709Z",
      "updated_at": "2026-09-14T11:33:44.636516Z"
    }
  }
]

List connected Core instances. Use instance_id (instance_...) on Proxy, Data, Filters, record counts, and lake requests.

Proxy and Data need instance_id (instance_...). List deployments and get deployment return deployment_id, not instance_id.

The live payload can include agent_api_key. Treat it as a secret. Do not commit it or paste it into tickets.

curl -X GET 'https://api.cloud.blnkfinance.com/instances' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response

[
  {
    "instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "ledger_instance_id": "",
    "name": "my-sandbox",
    "sync_status": "connected",
    "ledger_version": "",
    "connection_type": "agent",
    "instance_url": "https://my-sandbox-sharespaces.deployment.blnkfinance.com",
    "type": "cloud",
    "deployment_id": "deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "created_at": "2026-09-14T11:32:14.112322Z",
    "monitoring_enabled": true,
    "deployment": {
      "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",
      "has_db_access": false,
      "watch_enabled": false,
      "current_step": "FINALIZED",
      "operation_type": "deploy",
      "created_at": "2026-09-14T11:32:11.971709Z",
      "updated_at": "2026-09-14T11:33:44.636516Z"
    }
  }
]

The response is a JSON array of instance objects.

string

required

Cloud instance id (instance_...). Pass this as instance_id on Proxy, Data, Filters, and lake calls.

string

required

Instance display name.

string

Matching managed deployment id (deploy_...), when this instance is a Cloud deployment.

string

Connection state. Live values include connected.

string

How Cloud reaches Core. Live values include agent.

string

HTTPS Core URL for the instance.

string

Instance type. Live values include cloud.

object

Nested deployment summary when the instance is managed. Shape overlaps get deployment. It still does not replace instance_id at the top level.

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/instances' \
  -H 'Authorization: Bearer YOUR_API_KEY'

[
  {
    "instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "ledger_instance_id": "",
    "name": "my-sandbox",
    "sync_status": "connected",
    "ledger_version": "",
    "connection_type": "agent",
    "instance_url": "https://my-sandbox-sharespaces.deployment.blnkfinance.com",
    "type": "cloud",
    "deployment_id": "deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "created_at": "2026-09-14T11:32:14.112322Z",
    "monitoring_enabled": true,
    "deployment": {
      "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",
      "has_db_access": false,
      "watch_enabled": false,
      "current_step": "FINALIZED",
      "operation_type": "deploy",
      "created_at": "2026-09-14T11:32:11.971709Z",
      "updated_at": "2026-09-14T11:33:44.636516Z"
    }
  }
]

Start Here

Authentication

Deployments

Billing

Audit

Proxy & Data

Alerts

Integrations

Response

Need help?

​Response

​Need help?

Response

Need help?