Migrating from Cachet 2.x

Updated 2026-10-22 · Pharos 1.0.1

Three things are deliberately identical, so existing scripts survive:

GET /api/v1/components: same path, same envelope, same field names.
Status integers: 1 operational, 2 degraded, 3 partial, 4 major. Pharos adds 5 for maintenance.
X-Cachet-Token is accepted everywhere Bearer is, and POST works as an alias for PUT on a component.

What needs editing:

Creating incidents. Cachet took an integer status and a single component; Pharos takes a status name and a components object.
Endpoints that do not exist here: Cachet's metrics and metric points, actions, version, schedules, and fetching a single incident. Planned work lives under /maintenance, and /metrics here is the Prometheus endpoint, not Cachet's metrics.
No pagination parameters on components and incidents. Components return in one page; incidents are capped at the 50 most recent. Only the subscriber list is paged.

Since 1.0 these do exist: /ping, component groups, /subscribers, creating and deleting components, and deleting an incident. Mind one path: groups live under /groups here, not under Cachet's /components/groups. All of them are listed under API and tokens.

Your existing data does not have to be typed in again. See Importing from Cachet 2.x for the importer.