Naar hoofdinhoud gaan
POST
/
v1
/
monitors
/
{monitor_id}
Update 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.

Samenvoegingssemantiek: Metadata-updates volgen de aanpak van Stripe — nieuwe sleutels worden toegevoegd, bestaande sleutels worden bijgewerkt en sleutels die zijn ingesteld op een lege string "" worden verwijderd.

Autorisaties

Authorization
string
header
vereist

Bearer authenticatie header in de vorm Bearer , waar jouw auth token is.

Padparameters

monitor_id
string
vereist

Unieke monitor-identificatie. Moet beginnen met monitor_.

Pattern: ^monitor_

Body

application/json
metadata
object

Metadata patch. Lege tekenreekswaarden verwijderen sleutels.

frequency
string

Instructie voor schema in natuurlijke taal (bijvoorbeeld: 'elke dag om 9 uur America/Los_Angeles'). Als er geen tijdzone is opgegeven, wordt UTC gebruikt.

Respons

Monitor succesvol bijgewerkt.

id
string

Unieke monitor identificatie.

object
string
Voorbeeld:

"monitor"

team_id
string
status
enum<string>

Monitor levenscyclusstatus. Veelvoorkomende waarden: active (draait volgens schema), paused (schema uitgeschakeld via /pause, kan worden hervat via /resume), deleted (zacht verwijderd).

Beschikbare opties:
active,
paused,
deleted
fda_id
string
query
string

Monitoring intent in natuurlijke taal. Als de query een URL bevat, zal de monitor zich op die URL richten.

frequency
string

Schema-instructie in natuurlijke taal (bijvoorbeeld: 'elke dag om 9 uur America/Los_Angeles' of 'elke werkdag om 14:30'). Als er geen tijdzone is opgegeven, wordt UTC gebruikt.

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

Optioneel JSON-schema dat wordt gebruikt om gestructureerde monitor extractie-uitvoer af te dwingen.

error_message
string | null
created_at
integer

Unix-tijdstempel.

updated_at
integer

Unix-tijdstempel.