Skip to content

by Startups.Studio

Product Build and ship Monitor

Monitor.update

PATCH /{namespace}/monitors/{id}

Changes the given properties of a Monitor.

Noun: Monitor
Mode: do
Event: Monitor.updated

You, to your agent

Change the latest monitor.

curl -X PATCH https://api.sb/routewise.dev/monitors/monitor_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"internal"}'

import { $ } from 'startup-builder'

const monitor = await $.Monitor.update({ id: 'monitor_1', kind: 'internal' })

npx startup-builder do Monitor.update --json '{"id":"monitor_1","kind":"internal"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Monitor.update({ id: 'monitor_1', kind: 'internal' })"
  }
}

Update changes the given properties of a Monitor. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Monitor.
`kind`	`string`		`internal` watches the Startup’s own routes and jobs; `outside` watches the world, such as a rival’s price.
`target`	`string`		What it checks: a route, a Domain, a Keyword, a prompt or a page.
`every`	`string`		How often it runs, such as `1m` or `1d`.

Outputs

Output	Type	Required	Description
`monitor`	Monitor	required	The Monitor.

Effects

Emits Monitor.updated.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Monitor.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Monitor.list

Previous Page

Project

Next Page