Skip to main content
DELETE
/
api
/
v1
/
beam
/
{config_id}
Delete Beam Config Handler
curl --request DELETE \
  --url https://api.allium.so/api/v1/beam/{config_id} \
  --header 'X-API-KEY: <api-key>'
{
  "message": "<string>"
}
Deletes the pipeline configuration and tears down any active deployment (Kafka topics, workers, subscriptions). This action is irreversible.
Required permission: manage — owners only.
Path parameters:
ParameterDescription
config_idPipeline configuration ID
curl -X DELETE https://api.allium.so/api/v1/beam/${CONFIG_ID} \
  -H "X-API-Key: ${ALLIUM_API_KEY}"
Response: 
{ "message": "Pipeline abc123 successfully deleted" }
This permanently removes the pipeline config, all associated filter values, Kafka topics, and deployment resources. Use teardown if you only want to stop the pipeline while preserving the config.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
config_id
string
required

Response

Successful Response

​
message
string
required