Disk Usage Endpoint
Published 04 April 2024
The disk usage endpoint provided information about the disks on monitored entities. Additional documentation for this endpoint can be found by navigating to http://your-web-server:port/api-docs.
/api/v1/disk-usage
Parameters
| Name | Mandatory/Optional | Type | Default | Description |
|---|---|---|---|---|
| MonitoredEntityId | Optional | String | None | Monitored entity ID which can be retrieved from the monitored entities endpoint, can be used to restrict the result to a single monitored entity |
Attributes
| monitoredEntity | id and name of the monitored entity the disk belongs to. |
|---|---|
| groupName | The group the monitored entity belongs to. |
| clusterName | Name of the cluster on which the disk is located, empty if there is no cluster |
| machineName | The name of the machine the disk is on |
| diskName | The name of the disk |
| diskLabel | The label of the disk that is attached to the disk name |
| diskUsed | The amount of disk space used in bytes |
| diskSize | The total size of the disk in bytes |
| projectedSizeNow | The projected disk space used today in bytes |
| projectedSizeInOneYear | The project disk space used in a year in bytes |
| projectedDateForFullCapacityUsed | The projected date the disk will be full |
| sqlInstances | List of SQL servers on the machine in which the disk is located |
Limitation
| Rate limit | Defaults to 100 API requests per minute, you can refer rate limiting to change these default values. |
|---|---|
| Monitored Entities | Currently supports Windows machines, Linux machines and Amazon RDS hosts |
