> ## 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.

# Pause pipeline

> Stops a deployed pipeline from processing data without removing it.

Stops the pipeline from processing data. The config, sinks, and deployment stay in place, and Beam holds incoming data until you resume.

To resume, call [Deploy](/beam/api-reference/deployment/deploy). If the pipeline is not deployed, the call does nothing.

<Warning>
  **Paused pipelines can lose data.** While a pipeline is paused, Beam holds incoming data for up to **2 days**. Data older than that is dropped and is not delivered when you resume. See [Pausing and data retention](/beam/api-reference/overview#pausing-and-data-retention).
</Warning>

Use [Teardown](/beam/api-reference/deployment/teardown) instead to remove the deployment. After a teardown, data that arrives before the next deploy is not delivered.

<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}/pause \
  -H "X-API-Key: ${ALLIUM_API_KEY}"
```

**Response:**

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


## OpenAPI

````yaml _openapi/beam-api.json POST /api/v1/beam/{config_id}/pause
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}/pause:
    post:
      tags:
        - BEAM
      summary: Pause Beam Config Handler
      operationId: pause_beam_config_handler_api_v1_beam__config_id__pause_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

````