Saltar al contenido principal
POST
/
v1
/
monitors
/
{monitor_id}
/
pause
Pausar Monitor
curl --request POST \
  --url https://api.olostep.com/v1/monitors/{monitor_id}/pause \
  --header 'Authorization: Bearer <token>'
{
  "id": "monitor_5hktz469jy",
  "object": "monitor",
  "created_at": 1777983215,
  "updated_at": 1777986822,
  "cron_expression": "13 13 * * ? *",
  "fda_id": "fda_5hktz469jy",
  "frequency": "daily",
  "metadata": {},
  "notification_channel": "email",
  "notification_target": "example@olostep.com",
  "query": "Gather the new blogposts from example website and send me updates with new posts.",
  "status": "paused",
  "team_id": "team_5hktz469jyF"
}

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

Autorizaciones

Authorization
string
header
requerido

Encabezado de autenticación Bearer de la forma Bearer , donde es tu token de autenticación.

Parámetros de ruta

monitor_id
string
requerido

Identificador único del monitor. Debe comenzar con monitor_.

Pattern: ^monitor_

Respuesta

Monitor pausado con éxito. Devuelve el monitor con status establecido en paused.

id
string

Identificador único del monitor.

object
string
Ejemplo:

"monitor"

team_id
string
status
enum<string>

Estado del ciclo de vida del monitor. Valores comunes: active (ejecutándose según el horario), paused (horario deshabilitado vía /pause, se puede reanudar vía /resume), deleted (borrado suave).

Opciones disponibles:
active,
paused,
deleted
fda_id
string
query
string

Intención de monitoreo en lenguaje natural. Si la consulta incluye una URL, el monitor se centrará en esa URL.

frequency
string

Instrucción de horario en lenguaje natural (por ejemplo: 'todos los días a las 9am America/Los_Angeles' o 'cada día laborable a las 14:30'). Si no se especifica una zona horaria, se usa UTC.

cron_expression
string | null
notification_channel
enum<string>
Opciones disponibles:
email,
webhook,
sms
notification_target
string
metadata
object
output_schema
object

Esquema JSON opcional utilizado para imponer una salida estructurada de extracción del monitor.

error_message
string | null
created_at
integer

Marca de tiempo Unix.

updated_at
integer

Marca de tiempo Unix.