Deployments

Get deployment config

Retrieve configuration for a managed Core instance.

GET/deployments/{deployment_id}/config

Use this endpoint to see which configuration keys you can change on a deployment, and which overrides are already applied. See Managed instances to learn more.

By default, all deployments are provisioned with configs optimized for production workloads. You only need to set these keys if you want to change the default behavior to fit your specific use case.

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-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Path

deployment_idstringrequiredpath

Unique id of the deployment (deploy_...). Do not pass instance_id here.

Response

allowed_keysobject

Map of keys Cloud lets you override, with the expected type (int, bool, url, or json). See the Core configuration reference for what each key means.

configobject

Overrides you have applied. Empty when you have not changed any keys. The instance still runs the optimized defaults Cloud set when it created the deployment.

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

{
  "allowed_keys": {
    "BLNK_RATE_LIMIT_BURST": "int",
    "BLNK_RATE_LIMIT_CLEANUP_INTERVAL_SEC": "int",
    "BLNK_RATE_LIMIT_RPS": "int",
    "BLNK_SERVER_MAX_REQUEST_BODY_SIZE_MB": "int",
    "BLNK_SERVER_MAX_UPLOAD_SIZE_MB": "int",
    "BLNK_SLACK_WEBHOOK_URL": "url",
    "BLNK_TRANSACTION_BATCH_SIZE": "int",
    "BLNK_TRANSACTION_DISABLE_BATCH_REFERENCE_CHECK": "bool",
    "BLNK_TRANSACTION_ENABLE_COALESCING": "bool",
    "BLNK_TRANSACTION_ENABLE_QUEUED_CHECKS": "bool",
    "BLNK_TRANSACTION_LOCK_DURATION": "int",
    "BLNK_TRANSACTION_LOCK_WAIT_TIMEOUT": "int",
    "BLNK_TRANSACTION_MAX_QUEUE_SIZE": "int",
    "BLNK_TRANSACTION_MAX_WORKERS": "int",
    "BLNK_WEBHOOK_HEADERS": "json",
    "BLNK_WEBHOOK_URL": "url"
  },
  "config": {}
}

{
  "error": "Unable to load deployment configuration."
}