Aller au contenu principal

Metrics and health

All paths below use https://api.lordbase.com. Read conventions for headers, authentication, pagination and error handling. Values in responses are illustrative; examples show selected fields, not fixed quotas or service guarantees.

Developer tokens authorize only explicitly supported operations. Required scopes appear below; account, billing and token-management operations require a dashboard session. See token permissions.

Read current database metrics — GET​

GET /e/v1/developer/databases/{database_id}/metrics/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with read_databases (or api). Resource roles and quotas still apply.

Request and permissions: Workspace member; active or paused database; no body. Collects current engine metrics. 502 means collection failed; do not substitute zero usage.

Required path parameters: database_id (UUID).

Field reference: DatabaseMetrics. The operation above defines which fields to send.

Response: 200

{
  "database_id": "11111111-1111-4111-8111-111111111111",
  "database_name": "Example database",
  "status": "active",
  "storage_used_mb": 1,
  "active_connections": 1
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Read stored metrics history — GET​

GET /e/v1/developer/databases/{database_id}/metrics/history/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with read_databases (or api). Resource roles and quotas still apply.

Request and permissions: Workspace member. Optional query hours integer (default 24,max 168); nonnumeric values fall back to24. Supply a positive value. Results are stored samples, not a continuous guarantee.

Required path parameters: database_id (UUID).

Field reference: DatabaseMetrics. The operation above defines which fields to send.

Response: 200

{
  "database_id": "11111111-1111-4111-8111-111111111111",
  "hours": 24,
  "data_points": 0,
  "metrics": []
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Check database connectivity — GET​

GET /e/v1/developer/databases/{database_id}/health/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with read_databases (or api). Resource roles and quotas still apply.

Request and permissions: Workspace member; no body. Inspect the health fields even when HTTP status is200.

Required path parameters: database_id (UUID).

Field reference: HealthCheck. The operation above defines which fields to send.

Response: 200

{
  "database_id": "11111111-1111-4111-8111-111111111111",
  "database_name": "Example database",
  "database_status": "active",
  "status": "healthy",
  "connection": true,
  "accepting_connections": true
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.