03 - Monitoring API

api/tenants

Return the list of tenants in a multitenant environment.

Request

curl -s -k -X POST -H "Content-Type: application/json" -H "APIKEY: [YOUR_API_KEY]" -H "username: [YOUR_USERNAME]" -H "password: [YOUR_PASSWORD]" 'https://1.2.3.4:4000/api/tenants'

Response

[
  {
    "id": "tenant1",
    "name": "Tenant One",
    "remote_id": "sgbox"
  },
  {
    "id": "tenant2",
    "name": "Tenant Two",
    "remote_id": "sgbox"
  },
  {
    "id": "tenant3",
    "name": "Tenant Three",
    "remote_id": "sgbox"
  }
]

api/status

Available from version 6.4.2.

Returns several information about the status of the system:

• Hosts and probes status for each tenant
• Hosts number for each tenant
• License information
• Global file caching status

Tenant header is not available for this endpoint. Status API can be queried only by the admin user of the master tenant.

Request

curl -s -k -X POST -H "Content-Type: application/json" -H "APIKEY: [YOUR_API_KEY]" -H "username: [YOUR_USERNAME]" -H "password: [YOUR_PASSWORD]"  'https://1.2.3.4:4000/api/status'

Response

{
  "Tenant One": {
    "Hosts": [
      {
        "Description": "The local host",
        "Hostname": "localhost",
        "IP": "127.0.0.1",
        "LastTS": "2026-07-03 16:18:00",
        "Unit": "minute",
        "Delta": "2"
      }
    ],
    "TenantID": "tenant1",
    "license": {
      "LCE": {
        "TenantID": "tenant1",
        "days": 26845,
        "expirationdate": "2100-01-01 23:59:59",
        "maxhosts": null
      },
      "LM": {
        "TenantID": "tenant1",
        "days": 26845,
        "expirationdate": "2100-01-01 23:59:59",
        "maxhosts": "100"
      },
      "NVS": {
        "TenantID": "tenant1",
        "days": 26845,
        "expirationdate": "2100-01-01 23:59:59",
        "maxhosts": "100"
      },
      "SM": {
        "TenantID": "tenant1",
        "days": 26845,
        "expirationdate": "2100-01-01 23:59:59",
        "maxhosts": "100"
      },
      "owner": "TEST 01"
    }
  },
  "Probes": [
    {
      "Cores": "8",
      "Delta": "1",
      "HDD": "90%",
      "ID": "000C292BC075",
      "IP": "[THIS_IS_AN_IP]",
      "InQ": "1",
      "LastLog": "2026-07-03 16:18:55",
      "LastSeen": "2026-07-03 16:17:57",
      "OutQ": "1",
      "RAM": "66%",
      "Unit": "minute"
    }
  ],
  "sgbox_internals": {
    "caches": {
      "caching": 6,
      "main": 6,
      "ready": 0
    }
  }
}

Response Fields

JSON Key	Description
Hosts	Details about tenant’s hosts
Hosts.LasTS	Timestamp of the last log received by sgbox from the host
Hosts.Delta	Time difference since the last log received, in “Unit”
Hosts_count	Total number of hosts of the tenant
Probes	Details about tenant’s probes
Probes.LastLog	Timestamp of the last log received by sgboxfrom the probe
Probes.LastSeen	Timestamp of the last time the probe sent a hack to sgbox
Probes.Delta	Time difference since the LastSeen timestamp, in “Unit”
Probes.OutQ	Number of files waiting to be sent to SGBox
Probes.InQ	Number of files waiting to be processed by the probe
Probes.RAM	Amount of free RAM on the probe
Probes.HDD	Amount of HDD used by the probe
Probes.Cores	Number of CPU cores of the probe
License	Details about SGBox license
License.[MODULE].days	Days left before license expiration for the module