/systems/totals - Get systems status summary

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api.my.nethesis.it/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "my.nethesis.it MCP server": {
    "url": "https://api.my.nethesis.it/mcp"
  }
}
Close
GET /systems/totals
Bearer auth

Get systems heartbeat status summary for dashboard (requires Admin or Support role)

Query parameters

  • timeout integer

    Timeout in minutes for active/inactive determination

    Minimum value is 1, maximum value is 60. Default value is 15.

Responses

  • 200 application/json

    Systems status summary retrieved successfully

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object
      Hide data attributes Show data attributes object
      • total integer

        Total number of systems

      • active integer

        Number of systems that communicated within the last timeout minutes

      • inactive integer

        Number of systems that communicated but not within timeout minutes

      • unknown integer

        Number of systems that were created but never communicated

      • legacy integer

        Systems of this scope still living on the old my (legacy.my.nethesis.it) and not yet migrated here. Pushed by the legacy sync, so the value can be stale rather than wrong when that sync lags. They have no row here, so they never appear in the active/inactive/unknown breakdown and cannot be listed: their detail lives on the legacy portal. Transitional field, removed at the legacy decommission.

      • total_with_legacy integer

        total + legacy, i.e. the whole estate of this scope across both portals. Use it for a headline figure; use total whenever the number has to agree with the systems list.

      • timeout_minutes integer

        Timeout used for active/inactive determination
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 403 application/json

    Forbidden - insufficient permissions

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
GET /systems/totals 
curl \
 --request GET 'https://my.nethesis.it/backend/api/systems/totals' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "code": 200,
  "message": "system status retrieved",
  "data": {
    "total": 1250,
    "active": 1100,
    "inactive": 100,
    "unknown": 50,
    "legacy": 180,
    "total_with_legacy": 1430,
    "timeout_minutes": 15
  }
}
Response examples (401) 
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403) 
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}