Get instance details

Retrieve full details for a Core instance in your Blnk Cloud workspace.

GET /instances/{instance_id}

cURL

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

200

{
  "instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "ledger_instance_id": "",
  "name": "my-sandbox",
  "sync_status": "connected",
  "ledger_version": "",
  "connection_type": "agent",
  "agent_api_key": "sk_live_...",
  "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"
  }
}

An instance is any Core connected to your Cloud workspace, whether you host it on-prem or Blnk hosts it as a managed deployment. Cloud uses instance_id (instance_...) to route API requests to the right Core.

Use this endpoint only when you need to retrieve the Core secret for your managed deployment. Otherwise, use Get deployment details to get the deployment details.

The live payload can include secrets. Do not commit it or paste it into tickets.

To view all instances (on-prem and managed) in your workspace, use GET /instances alone with no instance ID.

---

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/instances/instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc' \
  -H 'X-blnk-key: CLOUD_API_KEY'

instance_id · string · required

Unique id of the instance (instance_...). Do not pass deployment_id here.

Response

200

{
  "instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "ledger_instance_id": "",
  "name": "my-sandbox",
  "sync_status": "connected",
  "ledger_version": "",
  "connection_type": "agent",
  "agent_api_key": "sk_live_...",
  "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"
  }
}

instance_id · string

Unique id for this connected Core (instance_...). Pass it on Proxy, Filters, Data Lake, and other Cloud APIs so Cloud routes the request to this Core.

name · string

Display name of the instance in your workspace.

sync_status · string

Whether Cloud can reach the instance. connected means the connection is healthy.

connection_type · string

How Cloud talks to Core. agent means Cloud uses the Query Agent. direct means Cloud connects to the database with stored credentials.

agent_api_key · string

Secret used to authenticate with this Core. What it is depends on how the instance is hosted. On a managed deployment, this is the Core secret key for the deployed Core. Use it as X-blnk-key when you directly call the Core’s APIs.

On a self-hosted instance, this is the Query Agent connection key. It matches the CONNECTION_KEY set when you connected the instance.

instance_url · string

Public HTTPS URL of this Core. Cloud uses it for actions that call the instance.

type · string

Where the Core runs. cloud is a managed deployment. on-prem is a Core you host.

deployment_id · string

Id of the matching managed deployment (deploy_...). Present only when Blnk hosts this instance. Use it with Deployments APIs, not as instance_id.

created_at · timestamp

When the instance was connected to the workspace.

monitoring_enabled · boolean

Whether Cloud Monitoring is on for this instance.

deployment · object

Nested summary of the managed deployment, when this instance is managed. Same shape as Get deployment details. Do not use the nested deployment_id in place of instance_id when routing Cloud APIs.

---

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.