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

# Bulk Stop Snapshot Topics

> Stop snapshot for sources identified by the selected topics.

Accepts topic DB IDs, resolves them to their source connectors, and stops
any running snapshots on those sources.

Note: Because snapshots run at the source level, stopping affects all topics
for that source, not just the selected ones.

Automatically detects the running snapshot type (incremental or blocking)
and uses the appropriate cancellation method:
- Incremental: Cancels via signal table, streaming continues.
- Blocking: Restarts the connector, streaming resumes after restart.

Returns partial success results — continues processing even if individual stop operations fail.



## OpenAPI

````yaml /openapi/openapi.json post /topics/bulk/stop-snapshot
openapi: 3.1.0
info:
  title: Streamkap REST API
  description: >-
    The Streamkap REST API allows you to programmatically manage your CDC
    pipelines, sources, destinations, transforms, and more.


    Authenticate using a bearer token obtained from the [Access
    Token](/api-reference/auth/access-token) endpoint with your API client
    credentials.
  contact:
    name: Streamkap Support
    url: https://streamkap.com/
    email: support@streamkap.com
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api.streamkap.com
    description: Production
security: []
tags:
  - name: Alerts
    description: Manage alert subscribers, preferences, and notification credentials.
  - name: Authentication
    description: Obtain and refresh access tokens, manage client credentials and roles.
  - name: Billing
    description: Retrieve usage metrics, summaries, and export billing data.
  - name: Consumer Groups
    description: List, inspect, and reset Kafka consumer group offsets.
  - name: Dashboard
    description: Retrieve organisation-level statistics and overview data.
  - name: Destinations
    description: Create, configure, and manage data destinations and their lifecycle.
  - name: Kafka Access
    description: Manage Kafka users and their access permissions.
  - name: Logs
    description: Query and summarise system logs.
  - name: Pipelines
    description: Create, configure, and manage CDC pipelines and their lifecycle.
  - name: Project Keys
    description: Manage project keys that bundle API credentials and optional Kafka access.
  - name: Schema Registry
    description: Browse schema subjects, versions, and retrieve schema definitions.
  - name: Services
    description: View and switch service metadata.
  - name: Sources
    description: >-
      Create, configure, and manage data sources, snapshots, and their
      lifecycle.
  - name: Tags
    description: Create, update, and manage resource tags for organisation.
  - name: Topics
    description: Browse topic details, statistics, configurations, metrics, and messages.
  - name: Transforms
    description: >-
      Create, deploy, and manage data transforms, unit tests, and implementation
      details.
paths:
  /topics/bulk/stop-snapshot:
    post:
      tags:
        - Topics
      summary: Bulk Stop Snapshot Topics
      description: >-
        Stop snapshot for sources identified by the selected topics.


        Accepts topic DB IDs, resolves them to their source connectors, and
        stops

        any running snapshots on those sources.


        Note: Because snapshots run at the source level, stopping affects all
        topics

        for that source, not just the selected ones.


        Automatically detects the running snapshot type (incremental or
        blocking)

        and uses the appropriate cancellation method:

        - Incremental: Cancels via signal table, streaming continues.

        - Blocking: Restarts the connector, streaming resumes after restart.


        Returns partial success results — continues processing even if
        individual stop operations fail.
      operationId: bulkStopSnapshotTopics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkTopicStopSnapshotReq'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationRes'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    BulkTopicStopSnapshotReq:
      properties:
        topic_ids:
          items:
            type: string
          type: array
          maxItems: 500
          minItems: 1
          title: Topic Ids
          description: List of topic DB IDs (_id) to operate on.
      additionalProperties: true
      type: object
      required:
        - topic_ids
      title: BulkTopicStopSnapshotReq
      description: >-
        Request model for bulk stop-snapshot operations at the topic level.


        Accepts topic DB IDs to identify the source connectors whose snapshots
        should be stopped.

        Because a snapshot runs at the source level, stopping affects all topics
        for that source,

        not just the selected ones.
    BulkOperationRes:
      properties:
        results:
          items:
            $ref: '#/components/schemas/BulkOperationResult'
          type: array
          title: Results
          description: Detailed results for each entity
        summary:
          $ref: '#/components/schemas/BulkOperationSummary'
          description: Summary statistics
      additionalProperties: true
      type: object
      required:
        - results
        - summary
      title: BulkOperationRes
      description: Response model for bulk operations.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    BulkOperationResult:
      properties:
        id:
          type: string
          title: Id
          description: Entity ID
        success:
          type: boolean
          title: Success
          description: Whether the operation succeeded
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: Success message or error details
        data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Data
          description: Optional data returned by the operation
      additionalProperties: true
      type: object
      required:
        - id
        - success
      title: BulkOperationResult
      description: Result for a single entity in a bulk operation.
    BulkOperationSummary:
      properties:
        total:
          type: integer
          title: Total
          description: Total number of entities processed
        succeeded:
          type: integer
          title: Succeeded
          description: Number of successful operations
        failed:
          type: integer
          title: Failed
          description: Number of failed operations
      additionalProperties: true
      type: object
      required:
        - total
        - succeeded
        - failed
      title: BulkOperationSummary
      description: Summary statistics for a bulk operation.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````