Skip to content

Commit

Permalink
System managed fields separated into new endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
mdegat01 committed Jul 30, 2024
1 parent d306897 commit 90ce372
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions docs/api/supervisor/endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,9 +278,7 @@ Get the add-on logo
</ApiEndpoint>

<ApiEndpoint path="/addons/<addon>/options" method="post">
Set the protection mode on an add-on.

This function is not callable by itself and you can not use `self` as the slug here.
Set the options for an add-on.

:::tip
To reset customized network/audio/options, set it `null`.
Expand All @@ -298,8 +296,6 @@ To reset customized network/audio/options, set it `null`.
| audio_input | float or null | The index of the audio input device |
| ingress_panel | boolean | `true` if ingress_panel is enabled |
| watchdog | boolean | `true` if watchdog is enabled |
| system_managed | boolean | `true` if managed by Home Assistant |
| system_managed_config_entry | boolean | ID of config entry managing addon |

**You need to supply at least one key in the payload.**

Expand All @@ -321,6 +317,31 @@ To reset customized network/audio/options, set it `null`.

</ApiEndpoint>

<ApiEndpoint path="/addons/<addon>/sys_options" method="post">
Change options specific to system managed addons.

This endpoint is only callable by Home Assistant and not by any other client.

**Payload**

| key | type | description |
| --------------------------- | ------------- | --------------------------------------- |
| system_managed | boolean | `true` if managed by Home Assistant |
| system_managed_config_entry | boolean | ID of config entry managing addon |

**You need to supply at least one key in the payload.**

**Example payload:**

```json
{
"system_managed": true,
"system_managed_config_entry": "abc123"
}
```

</ApiEndpoint>

<ApiEndpoint path="/addons/<addon>/options/validate" method="post">
Run a configuration validation against the current stored add-on configuration or payload.

Expand Down

0 comments on commit 90ce372

Please sign in to comment.