Skip to main content
PUT
/
api
/
v1
/
beam
/
{config_id}
Update Beam Config Handler
curl --request PUT \
  --url https://api.allium.so/api/v1/beam/{config_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "owner_org_team_user_id": "<string>",
  "pipeline_config": {
    "source": {
      "type": "pubsub",
      "is_zerolag": false
    },
    "transforms": [
      {
        "script": "<string>",
        "uid": "<string>",
        "type": "v8"
      }
    ],
    "sinks": [
      {
        "name": "<string>",
        "uid": "<string>",
        "type": "kafka"
      }
    ]
  },
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "static_egress_ip": false,
  "pod_size": "S"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "owner_org_team_user_id": "<string>",
  "pipeline_config": {
    "source": {
      "type": "pubsub",
      "is_zerolag": false
    },
    "transforms": [
      {
        "script": "<string>",
        "uid": "<string>",
        "type": "v8"
      }
    ],
    "sinks": [
      {
        "name": "<string>",
        "uid": "<string>",
        "type": "kafka"
      }
    ]
  },
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "static_egress_ip": false,
  "pod_size": "S"
}
Updates an existing pipeline configuration. After updating, deploy again to apply changes.
Required permission: edit — owners and editors.
Path parameters:
ParameterDescription
config_idPipeline configuration ID
Request body: UpdateBeamConfigRequest 
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 '{
    "name": "USDC Transfer Monitor (updated)",
    "description": "Updated description",
    "tags": ["production", "base"],
    "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.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
config_id
string
required

Body

application/json
​
id
string
required
​
name
string
required
​
description
string
required
​
owner_org_team_user_id
string
required
​
pipeline_config
BeamPipelineConfig · object
required
​
organization_id
string | null
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
tags
string[] | null
​
static_egress_ip
boolean
default:false
​
pod_size
enum<string>
default:S
Available options:
S,
M,
L,
XL

Response

Successful Response

​
id
string
required
​
name
string
required
​
description
string
required
​
owner_org_team_user_id
string
required
​
pipeline_config
BeamPipelineConfig · object
required
​
organization_id
string | null
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
tags
string[] | null
​
static_egress_ip
boolean
default:false
​
pod_size
enum<string>
default:S
Available options:
S,
M,
L,
XL