> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allium.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Deploy pipeline

> Deploys a pipeline to start processing data.

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.

<Note>
  **Required permission:** `edit` — owners and editors.
</Note>

**Path parameters:**

| Parameter   | Description               |
| :---------- | :------------------------ |
| `config_id` | Pipeline configuration ID |

```bash theme={null}
curl -X POST https://api.allium.so/api/v1/beam/${CONFIG_ID}/deploy \
  -H "X-API-Key: ${ALLIUM_API_KEY}"
```

**Response:**

```json theme={null}
{ "message": "Pipeline abc123 successfully deployed" }
```


## OpenAPI

````yaml _openapi/beam-api.json POST /api/v1/beam/{config_id}/deploy
openapi: 3.1.0
info:
  title: Allium Beam API
  description: Allium Beam — managed streaming pipelines on top of Allium Datastreams.
  version: 1.0.0
servers:
  - url: https://api.allium.so
security: []
paths:
  /api/v1/beam/{config_id}/deploy:
    post:
      tags:
        - BEAM
      summary: Deploy Beam Config Handler
      operationId: deploy_beam_config_handler_api_v1_beam__config_id__deploy_post
      parameters:
        - name: config_id
          in: path
          required: true
          schema:
            type: string
            title: Config Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeamMessageResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyBearer: []
components:
  schemas:
    BeamMessageResponse:
      properties:
        message:
          type: string
          title: Message
      type: object
      required:
        - message
      title: BeamMessageResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyBearer:
      type: apiKey
      in: header
      name: X-API-KEY

````