Skip to content

Developer Documentation

System & Administration

Endpoints for system monitoring, configuration, and developer tools.

Monitoring

Health Check

GET /health

Public endpoint to check system availability.

Query Parameters
Request Body
{}
Body Parameters
Test Request
Response
{
  "status": "ok",
  "timestamp": "2025-10-27T10:00:00+03:00"
}

Prometheus Metrics

GET /metrics

Exposes system metrics in Prometheus text format.

Query Parameters
Request Body
{}
Body Parameters
Response (text/plain)
# HELP nexbit_transactions_total Total transactions processed
# TYPE nexbit_transactions_total counter
nexbit_transactions_total{status="success"} 1024
nexbit_system_health 1

Administration (Admin Only)

Get Configuration

GET /v1/system/config

Retrieve current system feature flags and configuration.

Query Parameters
Request Body
{}
Body Parameters
Test Request
Response
{
  "status": "success",
  "features": {
    "maintenance_mode": false,
    "new_fees": true
  }
}

Update Configuration

POST /v1/system/config

Update system feature flags.

Request Body
{
  "maintenance_mode": true
}
Body Parameters
  • maintenance_mode (boolean, optional): Set to true to enable maintenance mode.
Test Request
Response
{
  "status": "success"
}

View Audit Logs

GET /v1/system/audit-logs

Retrieve system-wide audit logs for compliance and security monitoring.

Query Parameters
  • limit (integer, optional): Max records to return. Default 50.
  • offset (integer, optional): Pagination offset. Default 0.
  • entity_type (string, optional): Filter by entity (e.g., 'transaction').
  • entity_id (integer, optional): Filter by entity ID.
Request Body
{
  "limit": 50,
  "entity_type": "transaction"
}
Body Parameters
Test Request
Response
{
  "status": "success",
  "data": [
    {
      "log_id": 501,
      "action": "TRANSACTION_SETTLED",
      "entity_type": "transaction",
      "entity_id": 10056,
      "details": { "risk_score": 0.05 },
      "created_at": "2025-10-26 12:00:01"
    }
  ]
}

List Plugins

GET /v1/system/plugins

List all active system plugins.

Query Parameters
Request Body
{}
Body Parameters
Response
{
  "status": "success",
  "plugins": [
    "NexbitCore_v1",
    "AdvancedAnalytics"
  ]
}

Developer Tools

Reset Sandbox

POST /v1/sandbox/reset

Sandbox Only: Wipes all transactions, wallets, and rules for the authenticated user. Useful for resetting test state.

Request Body
{}
Body Parameters
Test Request
Response
{
  "status": "success",
  "message": "Sandbox environment reset."
}