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

# List Cluster Triggers

> List cluster triggers with filters and pagination.



## OpenAPI

````yaml post /v1/clusters/triggers/list
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/clusters/triggers/list:
    post:
      tags:
        - Cluster Triggers
      summary: List Cluster Triggers
      description: List cluster triggers with filters and pagination.
      operationId: list_triggers_v1_clusters_triggers_list_post
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/shared__clusters__triggers__models__ListTriggersRequest
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/shared__clusters__triggers__models__ListTriggersResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    shared__clusters__triggers__models__ListTriggersRequest:
      properties:
        cluster_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Cluster Id
          description: Filter by cluster ID
        trigger_type:
          anyOf:
            - $ref: >-
                #/components/schemas/shared__clusters__triggers__models__TriggerType
            - type: 'null'
          description: Filter by trigger type
        status:
          anyOf:
            - $ref: >-
                #/components/schemas/shared__clusters__triggers__models__TriggerStatus
            - type: 'null'
          description: Filter by status
        offset:
          type: integer
          minimum: 0
          title: Offset
          description: Pagination offset
          default: 0
        limit:
          type: integer
          maximum: 1000
          minimum: 1
          title: Limit
          description: Results per page
          default: 50
        sort_by:
          type: string
          title: Sort By
          description: Field to sort by
          default: created_at
        direction:
          type: string
          title: Direction
          description: Sort direction (asc/desc)
          default: desc
      type: object
      title: ListTriggersRequest
      description: Request to list triggers with filters and pagination.
    shared__clusters__triggers__models__ListTriggersResponse:
      properties:
        results:
          items:
            $ref: >-
              #/components/schemas/shared__clusters__triggers__models__TriggerModel
          type: array
          title: Results
          description: List of triggers
        total:
          type: integer
          title: Total
          description: Total number of triggers
        offset:
          type: integer
          title: Offset
          description: Current offset
        limit:
          type: integer
          title: Limit
          description: Current limit
      type: object
      required:
        - results
        - total
        - offset
        - limit
      title: ListTriggersResponse
      description: Response for list triggers request.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    shared__clusters__triggers__models__TriggerType:
      type: string
      enum:
        - cron
        - interval
        - event
        - conditional
      title: TriggerType
      description: >-
        Type of trigger for automated cluster execution.


        Supported trigger types:

        - **cron**: Schedule-based execution using cron expressions (e.g., daily
        at 2am)

        - **interval**: Fixed-interval execution (e.g., every 6 hours)

        - **event**: Event-driven execution (e.g., after 100 documents added)

        - **conditional**: Condition-based execution (e.g., when drift exceeds
        threshold)
    shared__clusters__triggers__models__TriggerStatus:
      type: string
      enum:
        - active
        - paused
        - disabled
        - failed
      title: TriggerStatus
      description: Status of a cluster trigger.
    shared__clusters__triggers__models__TriggerModel:
      properties:
        trigger_id:
          type: string
          title: Trigger Id
          description: Unique trigger ID
        cluster_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Cluster Id
          description: Optional link to cluster definition
        namespace_id:
          type: string
          title: Namespace Id
          description: Namespace ID
        internal_id:
          type: string
          title: Internal Id
          description: Organization internal ID
        execution_config:
          $ref: '#/components/schemas/TriggerExecutionConfig'
          description: Configuration for cluster execution
        trigger_type:
          $ref: '#/components/schemas/shared__clusters__triggers__models__TriggerType'
          description: Type of trigger
        schedule_config:
          additionalProperties: true
          type: object
          title: Schedule Config
          description: Type-specific schedule configuration
        status:
          $ref: >-
            #/components/schemas/shared__clusters__triggers__models__TriggerStatus
          description: Current status
          default: active
        last_triggered_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Triggered At
          description: Last time trigger fired
        last_execution_job_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Execution Job Id
          description: Job ID of last execution
        next_scheduled_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next Scheduled At
          description: Next scheduled execution time
        execution_count:
          type: integer
          title: Execution Count
          description: Total executions
          default: 0
        consecutive_failures:
          type: integer
          title: Consecutive Failures
          description: Consecutive execution failures
          default: 0
        last_execution_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Execution Status
          description: Status of last execution
        last_execution_error:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Execution Error
          description: Error from last execution
        event_counter:
          type: integer
          title: Event Counter
          description: Current event count since last trigger
          default: 0
        last_cooldown_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Cooldown At
          description: Last time cooldown was applied
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Last update timestamp
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
          description: User who created trigger
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Trigger description
      type: object
      required:
        - namespace_id
        - internal_id
        - execution_config
        - trigger_type
        - schedule_config
      title: TriggerModel
      description: Model for cluster trigger.
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    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
    TriggerExecutionConfig:
      properties:
        collection_ids:
          items:
            type: string
          type: array
          minItems: 1
          title: Collection Ids
          description: >-
            REQUIRED. List of collection IDs to cluster when trigger fires. Must
            contain at least one collection ID. All collections will be
            clustered together using the specified algorithm.
          examples:
            - - col_abc123
            - - col_products
              - col_inventory
        config:
          additionalProperties: true
          type: object
          title: Config
          description: >-
            REQUIRED. Clustering algorithm configuration. Must include
            'algorithm' field ('kmeans', 'hdbscan', 'hierarchical'). Additional
            fields depend on algorithm choice. K-means requires 'n_clusters'.
            HDBSCAN requires 'min_cluster_size'.
          examples:
            - algorithm: kmeans
              min_cluster_size: 2
              n_clusters: 5
            - algorithm: hdbscan
              min_cluster_size: 10
      type: object
      required:
        - collection_ids
        - config
      title: TriggerExecutionConfig
      description: >-
        Configuration for cluster execution when trigger fires.


        Defines what clustering algorithm and parameters to use when the trigger
        executes.


        Examples:
            K-means clustering on 3 collections:
                {
                    "collection_ids": ["col_abc123", "col_def456", "col_ghi789"],
                    "config": {
                        "algorithm": "kmeans",
                        "n_clusters": 5,
                        "min_cluster_size": 2
                    }
                }

            HDBSCAN clustering on single collection:
                {
                    "collection_ids": ["col_products"],
                    "config": {
                        "algorithm": "hdbscan",
                        "min_cluster_size": 10,
                        "min_samples": 5
                    }
                }

````