Passer au contenu principal
POST
/
v1
/
monitors
/
{monitor_id}
Mettre à jour le Moniteur
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.

Sémantique de fusion : Les mises à jour des métadonnées suivent l’approche de Stripe — les nouvelles clés sont ajoutées, les clés existantes sont mises à jour, et les clés définies sur une chaîne vide "" sont supprimées.

Autorisations

​
Authorization
string
header
requis

En-tête d'authentification Bearer sous la forme Bearer , où est ton jeton d'authentification.

Paramètres de chemin

​
monitor_id
string
requis

Identifiant unique du moniteur. Doit commencer par monitor_.

Pattern: ^monitor_

Corps

application/json
​
metadata
object

Patch de métadonnées. Les valeurs de chaîne vides suppriment les clés.

​
frequency
string

Instruction de planification en langage naturel (par exemple : 'tous les jours à 9h America/Los_Angeles'). Si aucun fuseau horaire n'est spécifié, UTC est utilisé.

Réponse

Moniteur mis à jour avec succès.

​
id
string

Identifiant unique du moniteur.

​
object
string
Exemple:

"monitor"

​
team_id
string
​
status
enum<string>

Statut du cycle de vie du moniteur. Valeurs courantes : active (exécution selon le planning), paused (planning désactivé via /pause, peut être repris via /resume), deleted (supprimé de manière temporaire).

Options disponibles:
active,
paused,
deleted
​
fda_id
string
​
query
string

Intention de surveillance en langage naturel. Si la requête inclut une URL, le moniteur se concentrera sur cette URL.

​
frequency
string

Instruction de planning en langage naturel (par exemple : 'tous les jours à 9h America/Los_Angeles' ou 'chaque jour de la semaine à 14:30'). Si aucun fuseau horaire n'est spécifié, UTC est utilisé.

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

Schéma JSON optionnel utilisé pour imposer une sortie structurée de l'extraction du moniteur.

​
error_message
string | null
​
created_at
integer

Horodatage Unix.

​
updated_at
integer

Horodatage Unix.