Skip to documentation
DocumentationAPI referenceGet server summary
GETBearer token

Get server summary

/api/v1/servers/summary

Count completed purchases and summarize current servers by status, region and auto-renew preference.

Request example

cURL
curl "https://tovahub.com/api/v1/servers/summary" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

Examples only. No requests are sent from this page.

Illustrative response
JSON
{
  "completedPurchases": 0,
  "purchasesByRegion": [],
  "currentServers": 0,
  "serversByStatus": [],
  "serversByRegion": [],
  "autoRenewEnabled": 0,
  "autoRenewDisabled": 0,
  "management": "Manage servers, renewals, and account settings in the TovaHub Dashboard.",
  "dashboard": "https://tovahub.com/dashboard/servers"
}

Parameters

No parameters.

Response

HTTP status 200

Summarize completed purchases and the current organization's active server records.

completedPurchasesnumber

Count of completed purchases.

purchasesByRegionarray

Completed purchase counts grouped by region.

purchasesByRegion[].regionstring

Region code.

purchasesByRegion[].countnumber

Purchase count.

currentServersnumber

Count of current non-deleted servers.

serversByStatusarray

Current server counts grouped by normalized status.

serversByStatus[].statusstring

Normalized status.

serversByStatus[].countnumber

Server count.

serversByRegionarray

Current server counts grouped by region.

serversByRegion[].regionstring

Region code.

serversByRegion[].countnumber

Server count.

autoRenewEnablednumber

Servers with auto-renew preference enabled.

autoRenewDisablednumber

Servers with auto-renew preference disabled.

managementstring

Dashboard management guidance.

dashboardstring (URL)

Dashboard server-list URL.