Deployments

Update deployment config

Update configuration for a managed Core instance.

PUT/deployments/{deployment_id}/config

Use this endpoint to override configuration on a deployment. Send only the keys you want to change. Cloud checks the keys against allowed_keys from Get deployment config, applies the overrides and restarts the instance.

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.

Body

The body is a JSON object of overrides. Include any one of the keys from allowed_keys on Get deployment config, or several. Omit keys you want to leave at the default. Do not send a key that is not in that list.

Key	Type
`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`

Match the type shown for each key. For what each key means, see the Core configuration reference.

Response

messagestring

Confirmation that the config was applied and the instance is restarting. Track progress with Get deployment details.

curl -X PUT 'https://api.cloud.blnkfinance.com/deployments/deploy_073f7ffe-9dfd-42ce-aa50-d1dca1788adc/config' \
  -H 'X-blnk-key: CLOUD_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "BLNK_WEBHOOK_URL": "https://example.com/webhooks/blnk"
  }'

{
  "message": "Configuration applied; your instance is restarting with the new settings"
}