Manage monitors

Every call below acts on a monitor you already created — see the Quickstart.

from seltz import Seltz

client = Seltz()
monitor_id = client.monitor.list(name="my-test-monitor").monitors[0].monitor_id

import { Seltz } from "seltz";

const client = new Seltz();
const monitorId = (await client.monitor.list({ name: "my-test-monitor" })).monitors[0].monitorId;

List monitors

list returns your organization’s monitors, paged with since and before and terminated by has_more. The default page size is 100 and the maximum is 1000.

page = client.monitor.list(limit=100)

for monitor in page.monitors:
    print(monitor.monitor_id, monitor.name, monitor.status)

print(page.has_more)

const page = await client.monitor.list({ limit: 100 });

for (const monitor of page.monitors) {
  console.log(monitor.monitorId, monitor.name, monitor.status);
}

console.log(page.hasMore);

MONITOR_ID="your-monitor-id"

curl "https://api.seltz.ai/v1/monitors?limit=100" \
  -H "x-api-key: $SELTZ_API_KEY"

Read one monitor

get returns the monitor together with its run_state, so one call gives you both the configuration and the state of the schedule.

response = client.monitor.get(monitor_id)

monitor = response.monitor
run_state = response.run_state

const response = await client.monitor.get(monitorId);

const monitor = response.monitor;
const runState = response.runState;

MONITOR_ID="your-monitor-id"

curl "https://api.seltz.ai/v1/monitors/$MONITOR_ID" \
  -H "x-api-key: $SELTZ_API_KEY"

There is no separate run_state method — get() returns both. See Reference.

Update a monitor

An omitted field keeps its current value. Updates carry no precondition and are last-writer-wins.

client.monitor.update(monitor_id, cadence="6h")

await client.monitor.update(monitorId, { cadence: "6h" });

MONITOR_ID="your-monitor-id"

curl -X PATCH "https://api.seltz.ai/v1/monitors/$MONITOR_ID" \
  -H "x-api-key: $SELTZ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cadence": "6h"}'

Setting search_requests replaces the list wholesale. A request keeps its id and its health when every field of its body is unchanged, so editing one query does not reset the others. A monitor must always hold at least one request, so an empty list is not a way to clear them: it leaves the list as it was. A request takes the same filters as a one-off search. A relative bound is re-evaluated on every run, so from_date: "now-7d" is a window that moves with the monitor; an absolute date does not. See Filter by date.

Pause and resume

Pausing is an update that sets status. A paused monitor keeps its configuration and its records but does not run. A monitor can also be paused for you. A skipped run’s status_reason says why. Resume a monitor paused this way with an ordinary update once the cause is fixed.

from seltz import MonitorStatus

client.monitor.update(monitor_id, status=MonitorStatus.MONITOR_STATUS_PAUSED)

# Resume
client.monitor.update(monitor_id, status=MonitorStatus.MONITOR_STATUS_ACTIVE)

import { MonitorStatus } from "seltz";

await client.monitor.update(monitorId, { status: MonitorStatus.PAUSED });

// Resume
await client.monitor.update(monitorId, { status: MonitorStatus.ACTIVE });

MONITOR_ID="your-monitor-id"

curl -X PATCH "https://api.seltz.ai/v1/monitors/$MONITOR_ID" \
  -H "x-api-key: $SELTZ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "paused"}'

The cURL and SDK tabs above do the same thing — the same status value is spelled differently per transport. See Reference.

Setting the status at create time is how you create a monitor without starting its schedule.

Delete a monitor

client.monitor.delete(monitor_id)

await client.monitor.delete(monitorId);

MONITOR_ID="your-monitor-id"

curl -X DELETE "https://api.seltz.ai/v1/monitors/$MONITOR_ID" \
  -H "x-api-key: $SELTZ_API_KEY"

Deleting is permanent. Every record becomes invisible at once, and the name is released for a new monitor to take.

Getting Started

Web Tools

Data

Tutorials

Chat

Integrations

SDKs

Manage monitors

List monitors

Read one monitor

Update a monitor

Pause and resume

Delete a monitor

​List monitors

​Read one monitor

​Update a monitor

​Pause and resume

​Delete a monitor

List monitors

Read one monitor

Update a monitor

Pause and resume

Delete a monitor