Sign in
Cluster Triggers

List Cluster Triggers

List cluster triggers with filters and pagination.

post/v1/clusters/triggers/list

Request body

cluster_idstring nullable

Filter by cluster ID

trigger_type'cron' | 'interval' | 'event' | 'conditional'

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)
status'active' | 'paused' | 'disabled' | 'failed'

Status of a cluster trigger.

offsetinteger

Pagination offset

limitinteger

Results per page

sort_bystring

Field to sort by

directionstring

Sort direction (asc/desc)

Response

Successful Response

totalinteger required

Total number of triggers

offsetinteger required

Current offset

limitinteger required

Current limit

Example response

{
  "results": [
    {
      "execution_config": {
        "collection_ids": [
          "col_abc123"
        ],
        "config": {
          "algorithm": "kmeans",
          "min_cluster_size": 2,
          "n_clusters": 5
        }
      }
    }
  ]
}

Changes

Changed in 1 of the 34 revisions of this API.1