Skip to main content
POST
/
api
/
v1
/
beam
/
{config_id}
/
deploy
Deploy Beam Config Handler
curl --request POST \
  --url https://api.allium.so/api/v1/beam/{config_id}/deploy \
  --header 'X-API-KEY: <api-key>'
{
  "message": "<string>"
}
Deploys the pipeline to start processing data. Creates Kafka topics, provisions credentials, and spins up workers. Deployment is idempotent — call it again after updating a config to apply changes with zero downtime. Do not teardown before redeploying.
Required permission: edit — owners and editors.
Path parameters:
ParameterDescription
config_idPipeline configuration ID
curl -X POST https://api.allium.so/api/v1/beam/${CONFIG_ID}/deploy \
  -H "X-API-Key: ${ALLIUM_API_KEY}"
Response: 
{ "message": "Pipeline abc123 successfully deployed" }

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
config_id
string
required

Response

Successful Response

​
message
string
required