jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-27 19:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for Supervisor /os/config/swap API (#2611)

Browse Source
This commit is contained in:
Jan Čermák 2025-03-31 14:14:02 +02:00 committed by GitHub
parent d80fb2fd04
commit 984daee8bd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/api/supervisor/endpoints.md
View File

@ -2582,6 +2582,40 @@ Change the active boot slot, **This will also reboot the device!**
</ApiEndpoint>
<ApiEndpoint path="/os/config/swap" method="get">
Get current HAOS swap configuration. Unavailable on Supervised.
**Returned data:**
| key | type | description |
|------------|--------|----------------------------------|
| swap_size | string | Current swap size. |
| swappiness | int | Current kernel swappiness value. |
**Example response:**
```json
{
"swap_size": "2G",
"swappiness": 1
}
```
</ApiEndpoint>
<ApiEndpoint path="/os/config/swap" method="post">
Set HAOS swap configuration. Unavailable on Supervised.
**Payload:**
| key | type | description |
|------------|--------|--------------------------------------------------------------------------------------------|
| swap_size | string | New swap siz as number with optional units (K/M/G). Anything lower than 40K disables swap. |
| swappiness | int | New swappiness value (0-100). |
</ApiEndpoint>
<ApiEndpoint path="/os/datadisk/list" method="get">
Returns possible targets for the new data partition.