Skip to main content
PUT
/
api
/
v1
/
beam
/
{config_id}
Update config
curl --request PUT \
  --url https://api.example.com/api/v1/beam/{config_id}

Documentation Index

Fetch the complete documentation index at: https://docs.allium.so/llms.txt

Use this file to discover all available pages before exploring further.

PUT /api/v1/beam/{config_id}
Updates an existing pipeline configuration. After updating, deploy again to apply changes. Path parameters:
ParameterDescription
config_idPipeline configuration ID
Request body: BeamConfig The full config object including pipeline_config. The owner_org_team_user_id is set from the authenticated API key. 
curl -X PUT https://api.allium.so/api/v1/beam/${CONFIG_ID} \
  -H "X-API-Key: ${ALLIUM_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "'${CONFIG_ID}'",
    "name": "USDC Transfer Monitor (updated)",
    "description": "Updated description",
    "pipeline_config": {
      "source": {
        "type": "pubsub",
        "chain": "base",
        "entity": "erc20_token_transfer",
        "is_zerolag": false
      },
      "transforms": [
        {
          "type": "redis_set_filter",
          "uid": "tf-001",
          "filter_expr": "root = this.token_address"
        }
      ],
      "sinks": [
        {
          "type": "kafka",
          "uid": "sk-001",
          "name": "usdc-transfers"
        }
      ]
    }
  }'
Response: BeamConfig
Remember to redeploy after updating to apply changes. Redeployment is idempotent with zero downtime.