Zum Hauptinhalt springen
POST
/
v1
/
monitors
/
{monitor_id}
Monitor aktualisieren
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.

Merge-Semantik: Metadatenaktualisierungen folgen dem Ansatz von Stripe — neue Schlüssel werden hinzugefügt, bestehende Schlüssel werden aktualisiert, und auf leeren String "" gesetzte Schlüssel werden gelöscht.

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer-Authentifizierungsheader in der Form Bearer , wobei dein Authentifizierungstoken ist.

Pfadparameter

​
monitor_id
string
erforderlich

Eindeutiger Monitor-Identifikator. Muss mit monitor_ beginnen.

Pattern: ^monitor_

Body

application/json
​
metadata
object

Metadaten-Patch. Leere Zeichenfolgenwerte löschen Schlüssel.

​
frequency
string

Anweisung im natürlichen Sprachformat für den Zeitplan (zum Beispiel: 'jeden Tag um 9 Uhr America/Los_Angeles'). Wenn keine Zeitzone angegeben ist, wird UTC verwendet.

Antwort

Monitor erfolgreich aktualisiert.

​
id
string

Eindeutige Monitor-Kennung.

​
object
string
Beispiel:

"monitor"

​
team_id
string
​
status
enum<string>

Monitor-Lebenszyklusstatus. Häufige Werte: active (läuft nach Zeitplan), paused (Zeitplan über /pause deaktiviert, kann über /resume fortgesetzt werden), deleted (soft-gelöscht).

Verfügbare Optionen:
active,
paused,
deleted
​
fda_id
string
​
query
string

Überwachungsabsicht in natürlicher Sprache. Wenn die Abfrage eine URL enthält, konzentriert sich der Monitor auf diese URL.

​
frequency
string

Zeitplananweisung in natürlicher Sprache (zum Beispiel: 'jeden Tag um 9 Uhr America/Los_Angeles' oder 'jeden Wochentag um 14:30'). Wenn keine Zeitzone angegeben ist, wird UTC verwendet.

​
cron_expression
string | null
​
notification_channel
enum<string>
Verfügbare Optionen:
email,
webhook,
sms
​
notification_target
string
​
metadata
object
​
output_schema
object

Optionales JSON-Schema, das verwendet wird, um eine strukturierte Monitor-Extraktionsausgabe zu erzwingen.

​
error_message
string | null
​
created_at
integer

Unix-Zeitstempel.

​
updated_at
integer

Unix-Zeitstempel.