跳转到主要内容
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 '
{
  "frequency": "<string>",
  "metadata": {},
  "notification": {
    "events": [],
    "channels": [
      {
        "target": "<string>",
        "events": []
      }
    ]
  }
}
'
{
  "id": "<string>",
  "object": "monitor",
  "query": "<string>",
  "tracked": {
    "type": "<string>",
    "urls": [
      "<string>"
    ],
    "web_query": "<string>"
  },
  "source_policy": {
    "include_urls": [
      "<string>"
    ],
    "exclude_urls": [
      "<string>"
    ],
    "include_domains": [
      "<string>"
    ],
    "exclude_domains": [
      "<string>"
    ]
  },
  "schedule": {
    "frequency": "<string>",
    "cron": "<string>",
    "timezone": "UTC",
    "next_run_at": "2023-11-07T05:31:56Z"
  },
  "notification": {
    "events": [],
    "channels": [
      {
        "target": "<string>",
        "events": []
      }
    ]
  },
  "webhook": {
    "url": "<string>"
  },
  "output_schema": {},
  "error_message": "<string>",
  "last_run": {
    "id": "<string>",
    "status": "completed",
    "change_detected": true,
    "ran_at": "2023-11-07T05:31:56Z"
  },
  "agent": {
    "id": "<string>"
  },
  "metadata": {},
  "created": 123,
  "updated": 123,
  "total_count": 123,
  "mermaid_diagram": "<string>"
}
合并语义: 元数据更新遵循 Stripe 的方法——新键被添加,现有键被更新,设置为空字符串 "" 的键被删除。

授权

Authorization
string
header
必填

Bearer认证头格式为Bearer ,其中是你的认证令牌。

路径参数

monitor_id
string
必填
Pattern: ^monitor_

请求体

application/json
frequency
string

自然语言计划文本。重新创建内部计划。

metadata
object

与现有元数据合并;空字符串值删除键。

notification
object
webhook
object

传递 null 以移除 webhook。

响应

监控已更新。

id
string

唯一的监视器标识符 (monitor_…)。

object
string
示例:

"monitor"

query
string

自然语言的监控意图。

tracked
object

计划完成后监视器跟踪的已解决目标。

source_policy
object

在计划和执行期间应用的可选 URL/域名允许和拒绝列表。

schedule
object
notification
object
webhook
object
output_schema
object

可选的JSON Schema用于结构化提取输出。

status
enum<string>

监控生命周期状态。

可用选项:
provisioning,
active,
paused,
failed,
deleted
error_message
string | null

statusfailed时出现。

last_run
object

最新快照摘要。包含在GET /v1/monitors/{monitor_id}中。

agent
object
metadata
object
created
integer

Unix时间戳(秒)。

updated
integer

Unix时间戳(秒)。

total_count
integer

快照总数。除非include_total_count=false,否则包含在GET /v1/monitors/{monitor_id}中。

mermaid_diagram
string

监控DAG的Mermaid流程图。当include-diagram=true时包含在获取请求中。