Skip to main content
POST
Create Beam Config Handler
Creates a new pipeline configuration. The response includes auto-generated fields (id, owner_org_team_user_id, created_at, updated_at). The caller is automatically granted owner, and their team is granted viewer_team (read access for teammates).
Required permission: any authenticated user (creator becomes the owner).
Request body: CreateBeamConfigRequest
Response: BeamConfig
Filter values are managed separately from the pipeline config. After creating a pipeline, use the filter values endpoints to populate set filter transforms.
See the Configuration reference for full details on sources, transforms, and sink types.

Authorizations

X-API-KEY
string
header
required

Body

application/json
name
string
required
description
string
required
pipeline_config
BeamPipelineConfig · object
required
tags
string[] | null
static_egress_ip
boolean
default:false

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