Saltar al contenido principal
POST
/
v1
/
monitors
/
{monitor_id}
Actualizar Monitor
curl --request POST \
  --url https://api.olostep.com/v1/monitors/{monitor_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "frequency": "<string>"
}
'
{
  "id": "<string>",
  "object": "monitor",
  "team_id": "<string>",
  "fda_id": "<string>",
  "query": "<string>",
  "frequency": "<string>",
  "cron_expression": "<string>",
  "notification_target": "<string>",
  "metadata": {},
  "output_schema": {},
  "error_message": "<string>",
  "created_at": 123,
  "updated_at": 123
}

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.

Semántica de fusión: Las actualizaciones de metadatos siguen el enfoque de Stripe: se añaden nuevas claves, se actualizan las claves existentes y las claves establecidas en una cadena vacía "" se eliminan.

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_

Cuerpo

application/json
​
metadata
object

Parche de metadatos. Los valores de cadena vacíos eliminan claves.

​
frequency
string

Instrucción de programación en lenguaje natural (por ejemplo: 'every day at 9am America/Los_Angeles'). Si no se especifica una zona horaria, se utiliza UTC.

Respuesta

Monitor actualizado exitosamente.

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