Deployments
Get deployment details
Retrieve a managed Core instance by deployment_id.
/deployments/{deployment_id}Use this endpoint to retrieve deployment details by deployment_id. See Managed instances to learn more.
The response includes instance_id. Pass that on Proxy, Filters, Data Lake, and other Cloud APIs. For the Core secret, use Get instance 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
deployment_idstring
Unique id of the deployment (deploy_...). Do not pass instance_id here.
Response
deployment_idstring
Unique id for this managed deployment (deploy_...). Use it with Deployments APIs. Do not pass it as instance_id when routing Cloud APIs.
instance_idstring
Unique id for the connected Core (instance_...). Pass it on Proxy, Filters, Data Lake, and other Cloud APIs so Cloud routes the request to this Core. Empty while the deployment is still being provisioned.
namestring
Display name of the instance in your workspace.
typestring
Deployment type: sandbox or production. Cloud assigns capacity from this value.
tierstring
Capacity Cloud assigned for this deployment, such as B1.Micro or B1.Standard. You do not choose this when you create the deployment.
statusstring
Current state of the deployment: PENDING, ACTIVE, DESTROYING, DESTROYED, or FAILED. PENDING means Cloud is still provisioning. Sandbox typically takes 7 - 10 minutes. Production can take 10 - 30 minutes.
regionstring
Datacenter code for the instance. Cloud assigns this for sandbox. You choose it for production.
dedicatedboolean
true when the instance runs on dedicated Production infrastructure. Sandbox is always false.
ingress_modestring
How Cloud routes traffic to the instance. Live values include shared and legacy.
domainstring
Hostname of the Core once the instance is reachable.
urlstring
HTTPS Core URL once the instance is reachable. Use this to call Core directly, with the Core secret from Get instance details.
watch_enabledboolean
Whether Watch is enabled.
usage_billing_enabledboolean
Whether usage-based billing is on for the organization.
usage_billing_enabled_attimestamp
When usage-based billing was enabled for the organization.
record_creates_blockedboolean
true when this instance has used its included records and organization usage-based billing is off, so new records cannot be created. false while the instance is within its allowance or usage-based billing is on. See Usage-based billing.
created_attimestamp
When the deployment was created.
updated_attimestamp
When the deployment was last updated.