13.9API reference
These are the main calls. Every call except the screenshot link is a POST to https://www.obsrvly.com/api/gw/<area>/obsrvly.v1.<Service>/<Call>, as in 13.1. Field names are camelCase and match the names in this guide.
| Area | What | Calls |
|---|---|---|
monitor | Monitors | CreateUrlMonitor, BulkCreateUrlMonitors, CreateApiMonitor, CreateBrowserMonitor, CreateHeartbeatMonitor, CreateTcpMonitor, CreateUdpMonitor, CreatePingMonitor, CreateDnsMonitor, CreateCertMonitor, CreateDomainMonitor, GetMonitor, ListMonitors, UpdateMonitor, DeleteMonitor |
monitor | Lookups (no key) | ListRegions, ListDnsRecordTypes, DiscoverMonitors |
monitor | Alert channels | CreateEmailChannel, CreateSlackChannel, CreateTeamsChannel, CreateDiscordChannel, CreateTelegramChannel, CreatePagerDutyChannel, CreatePushoverChannel, CreateWebhookChannel, GetAlertChannel, ListAlertChannels, UpdateAlertChannel, DeleteAlertChannel, ResendEmailVerification |
monitor | Secrets | CreateSecret, ListSecrets, DeleteSecret |
monitor | Maintenance | CreateMaintenanceWindow, ListMaintenanceWindows, DeleteMaintenanceWindow |
monitor | Status page | GetStatusPage, SaveStatusPage; GetPublicStatusPage (no key) |
monitor | Plan limits | GetPlanLimitUsage |
result | Results | ListExecutions, GetMonitorSummary, ListMonitorSummaries, GetMonitorSeries, GetGlobalSeries; GetPublicStatus (no key); the screenshot link (GET, 13.8); the Prometheus scrape (GET, 13.10) |
alert | Incidents and policy | ListIncidents, AcknowledgeIncident, ListEvaluations, GetAlertPolicy; ListPublicIncidents (no key) |
notification | Notifications | ListNotifications, TestChannel |
scheduler | Runs | TriggerNow, GetSchedule |
Dashboard only#
These calls exist but refuse an API key (13.2): CreateApiKey, ListApiKeys, DeleteApiKey, ListAuditEvents, UpdateSecretHosts and SetTeamAlertPolicy.