Monitor routes: update · StartupBuilder

Reference for Monitor, one group of Monitor routes.

Monitor.update

Changes the given properties of a Monitor. Verb page.

Text

PATCH /{namespace}/monitors/{id}

Path: id. Body, as JSON: the other inputs. Emits Monitor.updated.

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`.

Returns

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

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.	None.

Example

Terminal

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

JSON

{
  "api": "https://api.sb/leaseline.app",
  "monitor": {
    "$id": "https://api.sb/leaseline.app/monitors/monitor_8Ed0ESvvRl",
    "$type": "Monitor",
    "kind": "internal",
    "target": "/health"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Monitor.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Monitor.updateCopy Anchor Link

Monitor.update