Skip to main content
POST
/
v1
/
clusters
/
triggers
/
list
List Cluster Triggers
curl --request POST \
  --url https://api.mixpeek.com/v1/clusters/triggers/list \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <x-namespace>' \
  --data '
{
  "cluster_id": "<string>",
  "trigger_type": "cron",
  "status": "active",
  "offset": 0,
  "limit": 50,
  "sort_by": "created_at",
  "direction": "desc"
}
'
{
  "triggers": [
    {
      "namespace_id": "<string>",
      "internal_id": "<string>",
      "execution_config": {
        "collection_ids": [
          "<string>"
        ],
        "config": {}
      },
      "trigger_type": "cron",
      "schedule_config": {},
      "trigger_id": "<string>",
      "cluster_id": "<string>",
      "status": "active",
      "last_triggered_at": "2023-11-07T05:31:56Z",
      "last_execution_job_id": "<string>",
      "next_scheduled_at": "2023-11-07T05:31:56Z",
      "execution_count": 0,
      "consecutive_failures": 0,
      "last_execution_status": "<string>",
      "last_execution_error": "<string>",
      "event_counter": 0,
      "last_cooldown_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "description": "<string>"
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123
}

Headers

​
Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

​
X-Namespace
string
required

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Body

application/json

Request to list triggers with filters and pagination.

​
cluster_id
string | null

Filter by cluster ID

​
trigger_type
enum<string> | null

Filter by trigger type

Available options:
cron,
interval,
event,
conditional
​
status
enum<string> | null

Filter by status

Available options:
active,
paused,
disabled,
failed
​
offset
integer
default:0

Pagination offset

Required range: x >= 0
​
limit
integer
default:50

Results per page

Required range: 1 <= x <= 1000
​
sort_by
string
default:created_at

Field to sort by

​
direction
string
default:desc

Sort direction (asc/desc)

Response

Successful Response

Response for list triggers request.

​
triggers
TriggerModel · object[]
required

List of triggers

​
total
integer
required

Total number of triggers

​
offset
integer
required

Current offset

​
limit
integer
required

Current limit