Skip to main content
GET
/
api
/
v1
/
beam
/
{config_id}
Get Beam Config Handler
curl --request GET \
  --url https://api.allium.so/api/v1/beam/{config_id} \
  --header 'X-API-KEY: <api-key>'
{
  "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"
}
Returns a single pipeline config by ID.
Required permission: read — owners, editors, readers, and members of teams shared via viewer_team.
Path parameters:
ParameterDescription
config_idPipeline configuration ID
Response: BeamConfig
curl -X GET https://api.allium.so/api/v1/beam/${CONFIG_ID} \
  -H "X-API-Key: ${ALLIUM_API_KEY}"

Authorizations

X-API-KEY
string
header
required

Path Parameters

config_id
string
required

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