メインコンテンツへスキップ
POST
/
v1
/
monitors
モニターを作成
curl --request POST \
  --url https://api.olostep.com/v1/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "frequency": "hourly",
  "query": "<string>",
  "url": "<string>",
  "email": "<string>",
  "webhook_url": "<string>",
  "metadata": {}
}
'
{
  "id": "<string>",
  "object": "monitor",
  "status": "active",
  "agent_id": "<string>",
  "fda_id": "<string>",
  "schedule_id": "<string>",
  "query": "<string>",
  "url": "<string>",
  "frequency": "hourly",
  "cron_expression": "<string>",
  "notification_channel": "email",
  "notification_target": "<string>",
  "metadata": {},
  "created": 123,
  "updated": 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.

承認

Authorization
string
header
必須

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

ボディ

application/json
frequency
enum<string>
必須
利用可能なオプション:
hourly,
daily,
weekly
query
string

自然言語でのモニタリングの意図。urlが提供されている場合はオプションです。

url
string<uri>

モニターするURL。クエリが提供されている場合はオプションです。

email
string

通知用メール。webhook_urlとは相互排他的です。

webhook_url
string<uri>

通知用Webhook URL(http/https)。メールとは相互排他的です。

metadata
object

レスポンス

モニターが受け入れられ、アクティブ化されました。

id
string
object
string
:

"monitor"

status
string
:

"active"

agent_id
string
fda_id
string
schedule_id
string
query
string
url
string | null
frequency
enum<string>
利用可能なオプション:
hourly,
daily,
weekly
cron_expression
string
notification_channel
enum<string>
利用可能なオプション:
email,
webhook
notification_target
string
metadata
object
created
integer
updated
integer