Oh Dear API
OpenAPI 3.1 specification for the Oh Dear API, aligned with the public documentation and SDK. Authentication is via the HTTP Authorization Header using a…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
OpenAPI 3.1 specification for the Oh Dear API, aligned with the public documentation and SDK. Authentication is via the HTTP Authorization Header using a Bearer token. Requests for a resource you are not allowed to access return 404 Not Found, exactly like a resource that does not exist.
Endpoints 117
AI
- GETList AI responses
/monitors/:monitorId/ai-responsesRetrieve all AI responses for a monitor. - GETGet latest AI response
/monitors/:monitorId/ai-responses/latestRetrieve the most recent AI response for a monitor, including the raw_response. - GETGet a specific AI response
/monitors/:monitorId/ai-responses/:aiResponseIdRetrieve a specific AI response by ID, including the raw_response.
Application Health Checks
- GETList application health checks for a monitor
/monitors/:monitorId/application-health-checksRetrieve a list of application health checks associated with a specific monitor. - POSTSnooze an application health check
/monitors/:monitorId/application-health-checks/:applicationHealthCheckId/snoozeSnooze notifications for a specific application health check for a given duration in minutes. - POSTUnsnooze an application health check
/monitors/:monitorId/application-health-checks/:applicationHealthCheckId/unsnoozeRemove any active snooze from a specific application health check. - GETGet application health check history
/monitors/:monitorId/application-health-checks/:applicationHealthCheckIdRetrieve the history of results for a specific application health check. Newest items appear first.
Broken Links
- GETGet broken links for a monitor
/broken-links/:monitorIdRetrieve a list of broken links found by the broken links check for a specific monitor. Returns results from the latest completed crawl run by default. Pass… - POSTAdd a URL to the broken links whitelist
/monitors/:monitorId/add-to-broken-links-whitelistAdd a URL to the broken links whitelist for a specific monitor. The URL will be ignored in future broken links checks.
Crawled URLs
- GETGet crawled URLs summary
/crawled-urls/:monitorId/summaryReturns a summary with counts of all URLs found during a crawl run, not just the broken ones. Useful for understanding the scope of a crawl without fetching… - GETGet crawled URLs details
/crawled-urls/:monitorId/detailsReturns a paginated list of all URLs found during a crawl run (100 per page). Each entry includes the same fields as the broken links response. Returns…
Certificates
- GETGet certificate health for a monitor
/certificate-health/:monitorIdRetrieve the certificate health details for a specific monitor. Returns results from the latest completed run by default. Pass run_id to fetch results from a…
Check History
- GETList historical check runs
/monitors/:monitorId/checks/:checkType/runsReturns a paginated list of completed runs for any check type on a monitor. Only runs with a result of succeeded, warning, or failed are included. Runs are…
Checks
- GETGet summary for a check type on a monitor
/monitors/:monitorId/check-summary/:checkTypeRetrieve a summary of the latest result for a specific check type on a monitor. - POSTEnable a check
/checks/:checkId/enableEnable a specific check by its ID. - POSTDisable a check
/checks/:checkId/disableDisable a specific check by its ID. - POSTRequest an immediate run of a check
/checks/:checkId/request-runRequest an immediate run of a specific check. Optionally, custom HTTP headers can be provided for HTTP-based checks. - POSTSnooze notifications for a check
/checks/:checkId/snoozeSnooze notifications for a specific check for a given duration in minutes. - POSTRemove snooze from a check
/checks/:checkId/unsnoozeRemove any active snooze from a specific check.
Cron Checks
- POSTSnooze a cron check
/cron-checks/:cronCheckId/snoozeSnooze notifications for a specific cron check for a given duration in minutes. - POSTUnsnooze a cron check
/cron-checks/:cronCheckId/unsnoozeRemove any active snooze from a specific cron check. - GETList cron checks for a monitor
/monitors/:monitorId/cron-checksRetrieve a list of cron checks associated with a specific monitor. - POSTCreate a cron check
/monitors/:monitorId/cron-checksCreate a new cron job monitor for a specific monitor. You can create either a simple cron check (with frequency) or a cron expression-based check. For simple… - POSTBulk sync cron checks
/monitors/:monitorId/cron-checks/syncSynchronize all cron checks for a monitor. This is a destructive action - any cron job not included in the sync request will be removed. Useful for managing… - PUTUpdate a cron check
/cron-checks/:cronCheckDefinitionIdUpdate an existing cron check definition. - DELETEDelete a cron check
/cron-checks/:cronCheckDefinitionIdDelete a specific cron check by its ID. This action cannot be undone.
Detected Certificates
- GETList detected certificates for a monitor
/monitors/:monitorId/detected-certificatesRetrieve a paginated list of detected certificates for a specific monitor, with optional filtering and sorting. - GETGet a detected certificate
/monitors/:monitorId/detected-certificates/:certificateIdRetrieve details of a specific detected certificate by its ID for a given monitor.
DNS
- GETGet DNS history
/monitors/:monitorId/dns-history-itemsRetrieve the DNS history and any issues detected for a monitor's domain. Results are sorted in reverse chronological order. - GETGet a specific DNS history item
/monitors/:monitorId/dns-history-items/:dnsHistoryItemIdRetrieve a specific DNS history item by its ID.
DNS Blocklist
- GETList DNS blocklist history
/monitors/:monitorId/dns-blocklist-history-itemsRetrieve DNS blocklist check history items for a monitor. Results are sorted in reverse chronological order. - GETGet a specific DNS blocklist result
/monitors/:monitorId/dns-blocklist-history-items/:itemIdRetrieve a specific DNS blocklist history item by its ID.
Domain
- GETGet domain information
/monitors/:monitorId/domainRetrieve domain registration information from RDAP for a monitor's domain, including expiration dates and domain statuses.
Downtime
- GETDowntime periods for a monitor
/monitors/:monitorId/downtimeRetrieve a list of downtime periods for a specific monitor within a defined time range. - DELETEDelete a downtime period
/downtime/:downtimeIdDelete a specific downtime period by its ID. This action is irreversible.
Lighthouse
- GETList Lighthouse reports
/monitors/:monitorId/lighthouse-reportsRetrieve all Lighthouse SEO reports for a monitor. The json_report field is not included in this list response. - GETGet latest Lighthouse report
/monitors/:monitorId/lighthouse-reports/latestRetrieve the most recent Lighthouse SEO report for a monitor, including the full json_report. - GETGet a specific Lighthouse report
/monitors/:monitorId/lighthouse-reports/:lighthouseReportIdRetrieve a specific Lighthouse SEO report by ID, including the full json_report.
Maintenance Periods
- GETList maintenance periods for a monitor
/monitors/:monitorId/maintenance-periodsRetrieve a list of maintenance periods associated with a specific monitor. - POSTStart an immediate maintenance period (default 60 minutes)
/monitors/:monitorId/start-maintenanceStart an immediate maintenance period for a specific monitor. By default, the maintenance period lasts 60 minutes, but you can specify a different duration in… - POSTStop the active maintenance period(s)
/monitors/:monitorId/stop-maintenanceStop any active maintenance period(s) for a specific monitor. - POSTCreate a scheduled maintenance period
/maintenance-periodsCreate a scheduled maintenance period for a specific monitor by providing the monitor ID, start time, and end time. - PUTUpdate a scheduled maintenance period
/maintenance-periods/:maintenancePeriodIdUpdate an existing scheduled maintenance period by its ID. - DELETEDelete a maintenance period
/maintenance-periods/:maintenancePeriodIdDelete a specific maintenance period by its ID. This action is irreversible.
Me
- GETGet current user
/meReturns the user and team info for the authenticated user. This endpoint can be used to retrieve information about the current user.
Mixed Content
- GETGet mixed content results for a monitor
/mixed-content/:monitorIdRetrieve a list of mixed content items found by the mixed content check for a specific monitor. Returns results from the latest completed crawl run by…
Monitors
- GETList monitors
/monitorsReturns a paginated list of monitors for the authenticated user's team. - POSTCreate a monitor
/monitorsCreate a new monitor for the authenticated user's team. - GETGet a monitor
/monitors/:monitorIdRetrieve detailed information about a specific monitor by its ID. - PUTUpdate a monitor
/monitors/:monitorIdUpdate the settings of an existing monitor. - DELETEDelete a monitor
/monitors/:monitorIdDelete a monitor by its ID. This action is irreversible. - GETGet a monitor by URL
/monitors/url/:monitorUrlRetrieve a monitor by its URL-encoded URL.
Notification Destinations
- GETGet team notification destinations
/team-notification-destinationsRetrieve all notification destinations defined at the team level for all your teams. Only team owners, admins, and members with access to all monitors see a… - POSTCreate team notification destination
/team-notification-destinations/:teamIdCreate a new notification destination for a team. Only team owners, admins, and members with access to all monitors can access this endpoint. - PUTUpdate team notification destination
/team-notification-destinations/:teamId/destination/:destinationIdUpdate an existing notification destination for a team. Only team owners, admins, and members with access to all monitors can access this endpoint. - DELETEDelete team notification destination
/team-notification-destinations/:teamId/destination/:destinationIdDelete a notification destination from a team. Only team owners, admins, and members with access to all monitors can access this endpoint. - POSTEnable team notification destination
/team-notification-destinations/:teamId/destination/:destinationId/enableRe-enable a previously disabled notification destination for a team. Keeps all settings and selected notification types, clears any automatic disable reason,… - POSTDisable team notification destination
/team-notification-destinations/:teamId/destination/:destinationId/disableDisable a notification destination for a team without deleting it. Keeps all settings and selected notification types but pauses sending notifications until… - GETGet monitor notification destinations
/monitors/:monitorId/notification-destinationsRetrieve all notification destinations for a specific monitor. Any team member with access to the monitor can access this endpoint. - POSTCreate monitor notification destination
/monitors/:monitorId/notification-destinationsCreate a new notification destination for a monitor. Team owners, admins, and members with access to the monitor can access this endpoint. Guests of the team… - PUTUpdate monitor notification destination
/monitors/:monitorId/notification-destinations/:destinationIdUpdate an existing notification destination for a monitor. Team owners, admins, and members with access to the monitor can access this endpoint. Guests of the… - DELETEDelete monitor notification destination
/monitors/:monitorId/notification-destinations/:destinationIdDelete a notification destination from a monitor. Team owners, admins, and members with access to the monitor can access this endpoint. Guests of the team… - POSTEnable monitor notification destination
/monitors/:monitorId/notification-destinations/:destinationId/enableRe-enable a previously disabled notification destination for a monitor. Keeps all settings and selected notification types, clears any automatic disable… - POSTDisable monitor notification destination
/monitors/:monitorId/notification-destinations/:destinationId/disableDisable a notification destination for a monitor without deleting it. Keeps all settings and selected notification types but pauses sending notifications… - GETGet tag notification destinations
/tags/notification-destinationsRetrieve all notification destinations defined at the tag level for all your teams. Only team owners, admins, and members with access to all monitors can… - POSTCreate tag notification destination
/tags/:tagId/notification-destinationsCreate a new notification destination for a tag. Only team owners, admins, and members with access to all monitors can access this endpoint. - PUTUpdate tag notification destination
/tags/:tagId/notification-destinations/:destinationIdUpdate an existing notification destination for a tag. Only team owners, admins, and members with access to all monitors can access this endpoint. - DELETEDelete tag notification destination
/tags/:tagId/notification-destinations/destination/:destinationIdDelete a notification destination from a tag. Only team owners, admins, and members with access to all monitors can access this endpoint. - POSTEnable tag notification destination
/tags/:tagId/notification-destinations/:destinationId/enableRe-enable a previously disabled notification destination for a tag. Keeps all settings and selected notification types, clears any automatic disable reason,… - POSTDisable tag notification destination
/tags/:tagId/notification-destinations/:destinationId/disableDisable a notification destination for a tag without deleting it. Keeps all settings and selected notification types but pauses sending notifications until it… - GETGet tag group notification destinations
/tag-groups/:tagGroupId/notification-destinationsRetrieve all notification destinations for a specific tag group. Only team owners, admins, and members with access to all monitors can access this endpoint. - POSTCreate tag group notification destination
/tag-groups/:tagGroupId/notification-destinationsCreate a new notification destination for a tag group. Only team owners, admins, and members with access to all monitors can access this endpoint. - PUTUpdate tag group notification destination
/tag-groups/:tagGroupId/notification-destinations/:destinationIdUpdate an existing notification destination for a tag group. Only team owners, admins, and members with access to all monitors can access this endpoint. - DELETEDelete tag group notification destination
/tag-groups/:tagGroupId/notification-destinations/:destinationIdDelete a notification destination from a tag group. Only team owners, admins, and members with access to all monitors can access this endpoint. - POSTEnable tag group notification destination
/tag-groups/:tagGroupId/notification-destinations/:destinationId/enableRe-enable a previously disabled notification destination for a tag group. Keeps all settings and selected notification types, clears any automatic disable… - POSTDisable tag group notification destination
/tag-groups/:tagGroupId/notification-destinations/:destinationId/disableDisable a notification destination for a tag group without deleting it. Keeps all settings and selected notification types but pauses sending notifications…
Ports
- GETList port scan history
/monitors/:monitorId/ports-history-itemsRetrieve port scan history items for a monitor. Results are sorted in reverse chronological order. - GETGet a specific port scan result
/monitors/:monitorId/ports-history-items/:itemIdRetrieve a specific port scan history item by its ID.
Public Metrics
- GETGet public metrics
/public-metricsRetrieve public API metrics (run count, notification count). This endpoint does not require authentication.
Recurring Maintenance Periods
- GETList recurring maintenance periods for a monitor
/monitors/:monitorId/recurring-maintenance-periodsRetrieve all recurring maintenance periods associated with a specific monitor. - GETGet a recurring maintenance period
/recurring-maintenance-periods/:recurringMaintenancePeriodIdRetrieve a specific recurring maintenance period by its ID. - PUTUpdate a recurring maintenance period
/recurring-maintenance-periods/:recurringMaintenancePeriodIdUpdate an existing recurring maintenance period. - DELETEDelete a recurring maintenance period
/recurring-maintenance-periods/:recurringMaintenancePeriodIdDelete a recurring maintenance period. Optionally delete all future periods generated from this recurrence. - POSTCreate a recurring maintenance period
/recurring-maintenance-periodsCreate a new recurring maintenance period for a monitor.
Reseller
- GETList all managed teams
/reseller/:resellerTeamId/managed-teamsRetrieve all teams managed by your reseller account. - POSTCreate a managed team
/reseller/:resellerTeamId/managed-teamsCreate a new team that will be managed by your reseller account. - GETGet a specific managed team
/reseller/:resellerTeamId/managed-teams/:managedTeamIdGet details for a specific managed team. - PUTUpdate a managed team
/reseller/:resellerTeamId/managed-teams/:managedTeamIdUpdate the name, timezone, or default uptime check location for a managed team. - DELETEDelete a managed team
/reseller/:resellerTeamId/managed-teams/:managedTeamIdDelete a managed team and all its associated data. This action cannot be undone. All monitors will be deleted, all users will be detached, and all pending… - POSTDecouple a managed team
/reseller/:resellerTeamId/managed-teams/:managedTeamId/decoupleRemove the reseller relationship from a managed team, making it independent. The team owner will receive an email notification. The team will retain all its… - POSTAdd a user to a managed team
/reseller/:resellerTeamId/managed-teams/:managedTeamId/usersAdd a user to a managed team. If a user with the given email already exists in the system, they will be added to the team. User roles: admin - Can perform any… - POSTGenerate login link for managed team user
/reseller/:resellerTeamId/managed-teams/:managedTeamId/users/:userId/generate-login-linkGenerate a secure, time-limited login link for a user of a managed team. The link will be valid for 5 minutes and automatically log the user into their…
Sitemap
- GETGet sitemap check results
/sitemap/:monitorIdRetrieve the sitemap check results for a monitor. Returns results from the latest completed run by default. Pass run_id to fetch results from a specific past…
Status Page Update Templates
- GETList status page update templates
/status-page-update-templatesRetrieve all status page update templates for your teams. - POSTCreate a status page update template
/status-page-update-templatesCreate a new reusable template for status page updates. - PUTUpdate a status page update template
/status-page-update-templates/:statusPageUpdateTemplateIdUpdate an existing status page update template. - DELETEDelete a status page update template
/status-page-update-templates/:statusPageUpdateTemplateIdDelete a status page update template. This action is irreversible.
Status Page Updates
- GETList updates for a status page
/status-pages/:statusPageId/updatesRetrieve a list of status page updates for a specific status page by its ID. - POSTCreate a status page update
/status-page-updatesCreate a new status page update by providing the status page ID, title, text, severity, time, and pinned status. - PUTUpdate a status page update
/status-page-updates/:statusPageUpdateIdUpdate an existing status page update by its ID. - DELETEDelete a status page update
/status-page-updates/:statusPageUpdateIdDelete a specific status page update by its ID. This action is irreversible.
Status Pages
- GETList status pages
/status-pagesRetrieve a paginated list of status pages, with optional pagination parameters. - POSTCreate a status page
/status-pagesCreate a new status page by providing the team ID, title, and associated monitors. Guests of the team cannot create status pages and receive a 404. - GETGet a status page
/status-pages/:statusPageIdRetrieve details of a specific status page by its ID, including associated monitors and recent updates. - DELETEDelete a status page
/status-pages/:statusPageIdDelete a specific status page by its ID. This action is irreversible. - POSTAdd monitors to a status page
/status-pages/:statusPageId/monitorsAdd one or more monitors to a specific status page, with an option to synchronize the status page with the current monitor statuses. - DELETERemove a monitor from a status page
/status-pages/:statusPageId/monitors/:monitorIdRemove a specific monitor from a status page by providing the status page ID and monitor ID.
Tag Groups
- GETList all tag groups
/tag-groupsRetrieve all tag groups for your teams. - POSTCreate a tag group
/tag-groupsCreate a new tag group for your team. Any tags that do not exist will be created. - PUTUpdate a tag group
/tag-groups/:tagGroupIdUpdate an existing tag group. An empty tags array will remove all tags from the group. Omit the tags property to only update the label. - DELETEDelete a tag group
/tag-groups/:tagGroupIdDelete an existing tag group.
Tags
- GETList all tags
/tagsRetrieve all tags for your teams. - POSTCreate a tag
/tagsCreate a new tag for your team.
Uptime
- GETUptime percentages for a monitor
/monitors/:monitorId/uptimeRetrieve uptime percentages for a specific monitor over a defined period, with optional granularity.
Uptime Metrics
- GETHTTP uptime metrics
/monitors/:monitorId/http-uptime-metricsRetrieve HTTP uptime metrics for a specific monitor over a defined period. - GETPing uptime metrics
/monitors/:monitorId/ping-uptime-metricsRetrieve ping uptime metrics for a specific monitor over a defined period. - GETTCP uptime metrics
/monitors/:monitorId/tcp-uptime-metricsRetrieve TCP uptime metrics for a specific monitor over a defined period.
API details
- Base URL
https://ohdear.app/api- Authentication
- A bearer token in the Authorization header
- Operations
- 117 operations on 93 pathsGET 51POST 39DELETE 15PUT 12
- Main resources
- Notification Destinations 24Reseller 8Cron Checks 7Checks 6Maintenance Periods 6Monitors 6Status Pages 6Recurring Maintenance Periods 5Application Health Checks 4Status Page Update Templates 4
- Response formats
application/json- Description format
- OpenAPI 3.1.2, API version
1.0.0 - Links
- OpenAPI document · Support
How to test the Oh Dear API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Oh Dear API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List AI responses” (GET /monitors/:monitorId/ai-responses), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Oh Dear API?
OpenAPI 3.1 specification for the Oh Dear API, aligned with the public documentation and SDK. Authentication is via the HTTP Authorization Header using a… It is listed under Developer tools and has 117 endpoints.
Who publishes the Oh Dear API?
It is listed from Oh Dear's public API description (an OpenAPI document), not published by Oh Dear on Swastik Codes. Anyone who controls ohdear.app can claim the profile by adding a DNS TXT record.
What is the base URL of the Oh Dear API?
Requests go to https://ohdear.app/api. Endpoint paths are added to this base URL.
How do I authenticate with the Oh Dear API?
With A bearer token in the Authorization header.
How many endpoints does the Oh Dear API have?
117 operations on 93 paths (51 GET, 39 POST, 15 DELETE, 12 PUT). The largest groups are Notification Destinations, Reseller, Cron Checks, Checks.
Is forking the Oh Dear API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.