Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductBuild and shipMonitor

Monitor routes: check

The Monitor Verbs check as api.sb routes, with inputs, result, refusals and an example.

Reference for Monitor, one group of Monitor routes.

Monitor.check

Check runs a Monitor once now from several regions and records the result as an Event. Verb page.

Text
POST /{namespace}/monitors/{monitor}/check

Path: monitor. Emits Monitor.checked.

Inputs

InputTypeRequiredDescription
monitorMonitorrequiredThe Monitor to run.

Returns

OutputTypeRequiredDescription
monitorMonitorrequiredThe Monitor, with its latest result.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/monitors/monitor_8Ed0ESvvRl/check \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
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.check",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update

Previous

Project

Next