Documentation / API Server Health and Metrics / Metrics and Alerting Concepts

Metrics and Alerting Concepts

Use health and service endpoints as inputs for alerting while keeping thresholds in your monitoring system.

Use health and service endpoints as inputs for alerting while keeping thresholds in your monitoring system.

Coverage

ItemStatus
GET /api/v1/health.phpAvailable
GET /api/v1/server-health.phpAvailable
GET /api/v1/services.phpAvailable

Workflow

  1. Confirm each route against the deployed route documentation.
  2. Test with a staging token first.
  3. Use read endpoints to inspect current state before any write operation.
  4. Record the external workflow ID in your own system.
  5. Review jobs, request logs, and audit logs after the workflow runs.

Notes

  • Do not create production automation around undocumented routes.
  • Use idempotency keys for write endpoints.
  • Keep rollback steps documented with the integration runbook.

Diagram

flowchart TD
    A[External System] --> B[Read Current State]
    B --> C{Expected State?}
    C -- No --> D[Stop and Alert]
    C -- Yes --> E[Run Approved Workflow]
    E --> F[Read Jobs and Logs]
    F --> G[Operator Review]
← Settings Endpoint Metrics Troubleshooting →