How do I update to the latest version of the Oh Dear API
THIS PAGE IS STILL A WORK IN PROGRESS, MORE INFORMATION WILL BE ADDED SOON
Generally speaking, we don't introduce any breaking changes to our API. On 23st of August 2025 however, we did deployed a new version of Oh Dear in which "sites" were renamed to "monitors" throughout the entire app. This change also affected our API. In this document, we want to help you understand the changed and give instruction on how to upgrade to the latest version of our API and packages.
Which changes have been introduced in our API
In Oh Dear "sites" have been renamed "monitors". This affects our API:
- The
/api/sites/
endpoint was renamed to/api/monitors
- Every field / request parameter named
site_id
was renamed tomonitor_id
We've restructured how we store various parameters for our checks. When you retrieve a site from our API, you'll now see various fields like uptime_check_settings
, broken_link_check_setttings
, ... that contains the settings for a check.
When creating or updating a monitor using our API, you can send along these settings fields as well to set or update the properties of a check.
Updated packages
We've also update our PHP SDK package and various other packages.
- ohdearapp/ohdear-php-sdk: this package has been rewritten from scratch. We recommend reading the readme to learn about the exact changes. Our SDK is now based on Saloon, which unlocks deep customizations.
- ohdearapp/ohdear-pulse: you should upgrade to v2. Upgrade instructions are here.
- ohdearapp/laravel-ohdear-webhooks: you should upgrade to v2. Upgrade instructions are here.