Get instance details

GET

instances

{instance_id}

curl -X GET 'https://api.cloud.blnkfinance.com/instances/instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc' \
  -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"
  }
}

Retrieve a connected Core instance by ID. Use instance_id (instance_...) on Proxy, Filters, record counts, and lake requests.

Proxy, Filters, and Data Lake need instance_id (instance_...). You can also read it from get deployment details. List deployments returns deployment_id only.

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

Authorization

Pass Authorization: Bearer YOUR_API_KEY or Authorization: Bearer YOUR_ACCESS_TOKEN.

string

required

Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

Path

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

string

required

Unique identifier of the instance to retrieve (instance_...).

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

string

required

Cloud instance id (instance_...). Pass this as instance_id on Proxy, 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 details. 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/instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc' \
  -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

Proxy & Data

Audit

Alerts

AI integrations

Billing

Authorization

Path

Response

Need help?

​Authorization

​Path

​Response

​Need help?

Authorization

Path

Response

Need help?