Skip to main content
POST
/
v1
/
clusters
/
triggers
/
{trigger_id}
/
pause
Pause Cluster Trigger
curl --request POST \
  --url https://api.mixpeek.com/v1/clusters/triggers/{trigger_id}/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <x-namespace>'
{
  "trigger_id": "<string>",
  "cluster_id": "<string>",
  "namespace_id": "<string>",
  "internal_id": "<string>",
  "execution_config": {
    "collection_ids": [
      "<string>"
    ],
    "config": {}
  },
  "trigger_type": "cron",
  "schedule_config": {},
  "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>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.

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.

Examples:

"Bearer sk_live_abc123def456"

"Bearer sk_test_xyz789"

​
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'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
trigger_id
string
required

Trigger ID

Response

Successful Response

Model for cluster trigger.

​
namespace_id
string
required

Namespace ID

​
internal_id
string
required

Organization internal ID

​
execution_config
object
required

Configuration for cluster execution

​
trigger_type
enum<string>
required

Type of trigger

Available options:
cron,
interval,
event,
conditional
​
schedule_config
object
required

Type-specific schedule configuration

​
trigger_id
string

Unique trigger ID

​
cluster_id
string | null

Optional link to cluster definition

​
status
enum<string>

Current status

Available options:
active,
paused,
disabled,
failed
​
last_triggered_at
string<date-time> | null

Last time trigger fired

​
last_execution_job_id
string | null

Job ID of last execution

​
next_scheduled_at
string<date-time> | null

Next scheduled execution time

​
execution_count
integer
default:0

Total executions

​
consecutive_failures
integer
default:0

Consecutive execution failures

​
last_execution_status
string | null

Status of last execution

​
last_execution_error
string | null

Error from last execution

​
event_counter
integer
default:0

Current event count since last trigger

​
last_cooldown_at
string<date-time> | null

Last time cooldown was applied

​
created_at
string<date-time>

Creation timestamp

​
updated_at
string<date-time>

Last update timestamp

​
created_by
string | null

User who created trigger

​
description
string | null

Trigger description