Skip to main content
PATCH
Pause or resume a monitor

Notes

  • To authenticate, you’ll need a Tako API key. It’s best practice to store it as an environment variable to avoid hardcoding sensitive credentials in your code.
  • status is the only field this endpoint takes, and nothing else on a monitor changes after create. To change a monitor’s type, parameters, channels, or window, delete it and create a new one.
  • Resuming a monitor whose active_until has already passed answers 400. That monitor is expired, not paused — recreate it with a new window.
  • Resuming clears last_evaluation_outcome back to null, because the pause invalidated that verdict.
  • Pausing keeps the monitor and its firings. Use it instead of delete when you want the history.

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

Resource id

Body

application/json
status
enum<string>
required
Available options:
active,
paused

Response

One monitor

id
string<uuid>
required
name
string
required
type
string
required
parameters
Parameters · object
required
fire_once
boolean
required
status
enum<string>
required
Available options:
active,
paused
status_reason
enum<string> | null
required

Why Tako paused the monitor. Null while the monitor is active, and null when you paused it yourself.

Available options:
fired_once,
unloadable,
expired,
completed
active_from
string<date-time> | null
required
active_until
string<date-time> | null
required
last_evaluated_at
string<date-time> | null
required

When the evaluation rule last ran for this monitor. Null until the first evaluation.

last_evaluation_outcome
enum<string> | null
required

How that evaluation ended. Null until the first evaluation, and null again after you resume a paused monitor, because the pause invalidated that verdict. An active monitor with no firings and a recent predates_monitor or before_window here is alive and waiting for an occurrence that happens after it was created. no_occurrence means the type read no occurrence, which includes finding no usable data to compare.

Available options:
fired,
already_fired,
no_occurrence,
predates_monitor,
outside_lookback,
unloadable,
completed,
unknown_type,
inactive,
deleted,
expired,
before_window,
crashed
channel_ids
string<uuid>[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required