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

# Stop a pipeline

> Stops or pauses the pipeline. `force=true` skips the graceful-stop checks.



## OpenAPI

````yaml /cdc-openapi.yaml post /pipelines/{id}/stop
openapi: 3.0.3
info:
  title: Integrate.io ELT & CDC REST API
  description: >
    The Integrate.io ELT & CDC REST API lets you list, create, update, start,
    stop, and archive

    ELT & CDC pipelines from outside the dashboard. Pipelines are described by a
    declarative

    definition document (YAML or JSON), so the same configuration can be
    version-controlled,

    reviewed, and reapplied across environments.


    ## Base URL

    All endpoints live under `/api/public/v1`.


    ## Authentication

    Requests are authenticated with a bearer API key:

    ```

    Authorization: Bearer fdk_<your-key>

    ```

    Every Integrate.io API key is prefixed with `fdk_`. The full key value is
    shown only once at

    creation time. Store it in a secret manager. If a key is lost or leaked,
    revoke it and mint a

    new one.


    **Create a key:** in the dashboard, go to **Settings > API Keys**, click
    **Create API key**,

    give it a name (for example `terraform-prod`), and optionally set an expiry.
    Copy the value from

    the confirmation dialog; it is not shown again. Only account admins can
    create or revoke keys.


    **Revoke a key:** from **Settings > API Keys**, open the action menu next to
    a key and choose

    **Revoke**. Revoked keys stop authenticating immediately and cannot be
    reactivated.


    ## Pipeline definition document

    Create, replace, and validate requests take a declarative definition
    document. For the full

    schema, supported transformation types, and examples, see

    [Pipeline definition import and
    export](/cdc/pipeline-definition-import-export#pipeline-definition-document).


    ## Errors

    Each endpoint documents its own responses. In general: `400` a definition
    failed validation

    (the body names the failing field), `401` missing or invalid API key, `403`
    the caller lacks

    admin privileges for key management, `404` the pipeline does not exist or
    belongs to another

    account (both return `404` to prevent enumeration), and `422` the request
    body has unknown keys

    or the wrong shape.
  version: '1.0'
  contact:
    name: Integrate.io Support
    url: https://www.integrate.io
servers:
  - url: https://{host}/api/public/v1
    variables:
      host:
        default: console.flydata.app
        description: >-
          API host. Confirm with the Integrate.io team; the API may instead be
          served from a dedicated host such as api.flydata.app. The public API
          lives under the /api/public/v1 base path.
security:
  - bearerAuth: []
tags:
  - name: Pipelines
    description: Manage ELT & CDC pipelines and their definitions.
paths:
  /pipelines/{id}/stop:
    parameters:
      - $ref: '#/components/parameters/PipelineId'
    post:
      tags:
        - Pipelines
      summary: Stop a pipeline
      description: >-
        Stops or pauses the pipeline. `force=true` skips the graceful-stop
        checks.
      operationId: stopPipeline
      parameters:
        - name: force
          in: query
          description: Skip the graceful-stop checks.
          schema:
            type: boolean
      responses:
        '200':
          description: The pipeline was stopped.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    PipelineId:
      name: id
      in: path
      required: true
      schema:
        type: integer
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: >-
        The pipeline does not exist, or it belongs to another account. Unknown
        IDs and other-account IDs both return 404 to prevent enumeration.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer API key, prefixed with fdk_.

````