跳转到主要内容
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)。与 email 互斥。

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