Monitor methods: check
The Monitor Verbs check as typed SDK methods, with inputs, result, refusals and an example.
Reference for Monitor, one group of Monitor methods.
Monitor.check
Check runs a Monitor once now from several regions and records the result as an Event. Verb page.
interface MonitorVerbs {
check(input: MonitorCheckInput, options?: SB.CallOptions): SB.Call<Monitor>
}Emits Monitor.checked.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
monitor | Monitor | required | The Monitor to run. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
monitor | Monitor | required | The Monitor, with its latest result. |
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
import { $ } from 'startup-builder'
const monitor = await $.Monitor.check({ monitor: 'monitor_8Ed0ESvvRl' })