Logical disks in use across the estate, their space usage and projected growth, and the servers that store data on each one.

Operations

List disk usage

Returns every logical disk across the estate when not filtered, together with its space usage, projected growth, and the servers associated with its owning machine. For non-SQL Server instances, the association to the machine does not guarantee that the instance stores data on that disk. A disk with no associated servers has an empty servers array. Supply one or more entity IDs to restrict the results. Omit entityIds to return every disk in the estate.

GET /api/v2/disk-usage

curl -G https://your-host/api/v2/disk-usage \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "entityIds=value"

Query parameters

entityIds array · entity-id OPTIONAL

Optional entity IDs to restrict results to. Repeat the parameter for multiple values. Can use the entityId values returned by GET /monitored-servers. A disk is included when one of the supplied IDs matches, or is an ancestor of, the disk itself or any of the servers listed in its servers array. Omit to return every disk in the estate.

Responses

200 — Disk usage for the matching logical disks

Response object: DiskUsage array

{
  "data": [
    {
      "id": "r1,4:base,s36:4bba3b44-5634-4b33-aff8-f53c4315efe3,7:Cluster,1,4:Name,s15:dev-prod,7:Machine,1,4:Name,s5:node01,11:LogicalDisk,1,4:Name,s2:C:,,",
      "name": "C:",
      "label": "SystemVolume",
      "parentEntity": {
        "entityId": "r1,4:base,s36:4bba3b44-5634-4b33-aff8-f53c4315efe3,7:Cluster,1,4:Name,s15:dev-prod,",
        "entityName": "prod-host-01",
        "entityType": "SqlServer",
        "parentEntity": null
      },
      "spaceUsedKilobytes": 53687091,
      "capacityKilobytes": 107374182,
      "projectedSpaceUsedInOneYearKilobytes": 85899345,
      "projectedDateForFullCapacityUsed": "2026-03-01T00:00:00Z",
      "servers": [
        {
          "serverName": "instance1",
          "serverType": "SqlServer",
          "serverEntityId": "r1,4:base,s36:4bba3b44-5634-4b33-aff8-f53c4315efe3,7:Cluster,1,4:Name,s15:dev-prod,12:SqlServer,1,4:Name,s8:instance1,"
        }
      ]
    }
  ],
  "status": "success"
}

{
  "status": "fail",
  "data": {}
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "fail",
  "data": {}
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "status": "error",
  "message": "string"
}