メインコンテンツへスキップ
POST
/
v1
/
monitors
/
{monitor_id}
モニターを更新
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.

マージのセマンティクス: メタデータの更新はStripeのアプローチに従います — 新しいキーは追加され、既存のキーは更新され、空の文字列 "" に設定されたキーは削除されます。

承認

Authorization
string
header
必須

Bearer 形式のBearer認証ヘッダー。はあなたの認証トークンです。

パスパラメータ

monitor_id
string
必須

ユニークなモニター識別子。monitor_で始める必要があります。

Pattern: ^monitor_

ボディ

application/json
metadata
object

メタデータパッチ。空の文字列値はキーを削除します。

frequency
string

自然言語のスケジュール指示(例: 'every day at 9am America/Los_Angeles')。タイムゾーンが指定されていない場合、UTCが使用されます。

レスポンス

モニターが正常に更新されました。

id
string

ユニークなモニター識別子。

object
string
:

"monitor"

team_id
string
status
enum<string>

モニターのライフサイクルステータス。一般的な値: active (スケジュール通りに実行中), paused (/pauseでスケジュールが無効化され、/resumeで再開可能), deleted (ソフト削除)。

利用可能なオプション:
active,
paused,
deleted
fda_id
string
query
string

自然言語でのモニタリングの意図。クエリにURLが含まれている場合、モニターはそのURLに焦点を当てます。

frequency
string

自然言語でのスケジュール指示(例: '毎日午前9時 America/Los_Angeles' または '毎週平日14:30')。タイムゾーンが指定されていない場合は、UTCが使用されます。

cron_expression
string | null
notification_channel
enum<string>
利用可能なオプション:
email,
webhook,
sms
notification_target
string
metadata
object
output_schema
object

構造化されたモニター抽出出力を強制するために使用されるオプションのJSONスキーマ。

error_message
string | null
created_at
integer

Unixタイムスタンプ。

updated_at
integer

Unixタイムスタンプ。