Deployments
Get instance details
Retrieve full details for a Core instance in your Blnk Cloud workspace.
/instances/{instance_id}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.
Enterprise authentication
Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.
Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.
This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.
X-blnk-keystring
Enterprise API key, or an OAuth access token.
Path
instance_idstring
Unique id of the instance (instance_...). Do not pass deployment_id here.
Response
instance_idstring
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.
namestring
Display name of the instance in your workspace.
sync_statusstring
Whether Cloud can reach the instance. connected means the connection is healthy.
connection_typestring
How Cloud talks to Core. agent means Cloud uses the Query Agent. direct means Cloud connects to the database with stored credentials.
agent_api_keystring
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_urlstring
Public HTTPS URL of this Core. Cloud uses it for actions that call the instance.
typestring
Where the Core runs. cloud is a managed deployment. on-prem is a Core you host.
deployment_idstring
Id of the matching managed deployment (deploy_...). Present only when Blnk hosts this instance. Use it with Deployments APIs, not as instance_id.
created_attimestamp
When the instance was connected to the workspace.
monitoring_enabledboolean
Whether Cloud Monitoring is on for this instance.
deploymentobject
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.