Skip to content

Commit adecee9

Browse files
authored
Add disk usage endpoint to supervisor (#2750)
1 parent b9af387 commit adecee9

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

docs/api/supervisor/endpoints.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1906,6 +1906,68 @@ Shutdown the host
19061906

19071907
</ApiEndpoint>
19081908

1909+
<ApiEndpoint path="/host/disks/<disk>/usage" method="get">
1910+
Get detailed disk usage information in bytes.
1911+
1912+
The only supported `disk` for now is "default". It will return usage info for the data disk.
1913+
1914+
Supports an optional `max_depth` query param. Defaults to 1
1915+
1916+
**Example response:**
1917+
1918+
```json
1919+
{
1920+
"id": "root",
1921+
"label": "Default",
1922+
"total_space": 503312781312,
1923+
"used_space": 430245011456,
1924+
"children": [
1925+
{
1926+
"id": "system",
1927+
"label": "System",
1928+
"used_space": 75660903137
1929+
},
1930+
{
1931+
"id": "addons_data",
1932+
"label": "Addons data",
1933+
"used_space": 42349200762
1934+
},
1935+
{
1936+
"id": "addons_config",
1937+
"label": "Addons configuration",
1938+
"used_space": 5283318814
1939+
},
1940+
{
1941+
"id": "media",
1942+
"label": "Media",
1943+
"used_space": 476680019
1944+
},
1945+
{
1946+
"id": "share",
1947+
"label": "Share",
1948+
"used_space": 37477206419
1949+
},
1950+
{
1951+
"id": "backup",
1952+
"label": "Backup",
1953+
"used_space": 268350699520
1954+
},
1955+
{
1956+
"id": "ssl",
1957+
"label": "SSL",
1958+
"used_space": 202912633
1959+
},
1960+
{
1961+
"id": "homeassistant",
1962+
"label": "Home assistant",
1963+
"used_space": 444090152
1964+
}
1965+
]
1966+
}
1967+
```
1968+
1969+
</ApiEndpoint>
1970+
19091971
### Ingress
19101972

19111973
<ApiEndpoint path="/ingress/panels" method="get">

0 commit comments

Comments
 (0)