Monitors

Monitor endpoints return information about monitors and provide some monitor controls through POST methods.

An endpoint might reference all monitors or a single monitor as documented. Single-monitor endpoints require query key id to identify the monitor, which is a config.monitor.id value. Use GET /monitors to discover monitor IDs if you don’t set them explicitly in the Blip config file.


GET /monitors

Returns a list of all loaded monitors keyed on config.monitor.id. The value for each is its redacted DSN (no password).

GET

/monitors

Response

{
  "localhost": "blip:...@unix(/tmp/mysql.sock)/?parseTime=true"
}

POST /monitors/reload

Reloads all monitors. See Monitors / Loading / Reloading.

Reloading only affects new and removed monitors. Monitors that did not change are not affected, even on error.

GET

/monitors/reload

Response

None on success (200 status code).

Error message on 4xx or 5xx status code.

Status Codes

409: Error reloading monitors

412: Stop-loss prevented reloading

POST /monitors/start?id=ID

Starts one monitor. id query key is required.

GET

/monitors/start?id=ID

Query

Key Value Required Purpose
id config.monitor.id Yes Monitor to start

Response

None on success (200 status code).

Error message on 4xx or 5xx status code.

Status Codes

409: Error starting monitor

POST /monitors/stop?id=ID

Stops one monitor. id query key is required.

The monitor is stopped but not unloaded, which means it reported by status endpoints.

POST

/monitors/stop?id=ID

Query

Key Value Required Purpose
id config.monitor.id Yes Monitor to stop

Response

None on success (200 status code).

Error message on 4xx or 5xx status code.