mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-09 18:36:29 +00:00
pwned on options validation (#917)
Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
parent
e623d0dca6
commit
cc11cb87f5
@ -293,7 +293,20 @@ To reset customized network/audio/options, set it `null`.
|
|||||||
</ApiEndpoint>
|
</ApiEndpoint>
|
||||||
|
|
||||||
<ApiEndpoint path="/addons/<addon>/options/validate" method="post">
|
<ApiEndpoint path="/addons/<addon>/options/validate" method="post">
|
||||||
Run a configuration validation against the current stored add-on configuration.
|
Run a configuration validation against the current stored add-on configuration or payload.
|
||||||
|
|
||||||
|
**Payload:**
|
||||||
|
|
||||||
|
Optional the raw add-on options.
|
||||||
|
|
||||||
|
**Returned data:**
|
||||||
|
|
||||||
|
| key | type | description |
|
||||||
|
| ---------------- | ----------- | -------------------------------- |
|
||||||
|
| message | string | Include the error message |
|
||||||
|
| valid | boolean | If config is valid or not |
|
||||||
|
| pwned | boolean | None | True or false if include pwned secrets. On error it's None |
|
||||||
|
|
||||||
</ApiEndpoint>
|
</ApiEndpoint>
|
||||||
|
|
||||||
<ApiEndpoint path="/addons/<addon>/options/config" method="get">
|
<ApiEndpoint path="/addons/<addon>/options/config" method="get">
|
||||||
@ -2167,6 +2180,44 @@ Returns information about a store repository
|
|||||||
|
|
||||||
</ApiEndpoint>
|
</ApiEndpoint>
|
||||||
|
|
||||||
|
### Security
|
||||||
|
|
||||||
|
<ApiEndpoint path="/security/info" method="get">
|
||||||
|
|
||||||
|
Returns information about the security features
|
||||||
|
|
||||||
|
**Returned data:**
|
||||||
|
|
||||||
|
| key | type | description |
|
||||||
|
| ------------------- | ------------ | ------------------------------------------------------------- |
|
||||||
|
| content_trust | bool | If content-trust is enabled or disabled on the backend |
|
||||||
|
| pwned | bool | If pwned check is enabled or disabled on the backend |
|
||||||
|
| force_security | bool | If force-security is enabled or disabled on the backend |
|
||||||
|
|
||||||
|
**Example response:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"content_trust": true,
|
||||||
|
"pwned": true,
|
||||||
|
"force_security": false,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ApiEndpoint>
|
||||||
|
|
||||||
|
<ApiEndpoint path="/security/options" method="post">
|
||||||
|
|
||||||
|
**Payload:**
|
||||||
|
|
||||||
|
| key | type | description |
|
||||||
|
| ------------------- | ------ | ------------------------------------------------------ |
|
||||||
|
| content_trust | bool | Disable/Enable content-trust |
|
||||||
|
| pwned | bool | Disable/Enable pwned |
|
||||||
|
| force_security | bool | Disable/Enable force-security |
|
||||||
|
|
||||||
|
</ApiEndpoint>
|
||||||
|
|
||||||
### Supervisor
|
### Supervisor
|
||||||
|
|
||||||
<ApiEndpoint path="/supervisor/info" method="get">
|
<ApiEndpoint path="/supervisor/info" method="get">
|
||||||
@ -2181,8 +2232,6 @@ Returns information about the supervisor
|
|||||||
| version_latest | string | The latest published version in the active channel |
|
| version_latest | string | The latest published version in the active channel |
|
||||||
| update_available | boolean | `true` if an update is available |
|
| update_available | boolean | `true` if an update is available |
|
||||||
| arch | string | The architecture of the host (armhf, aarch64, i386, amd64) |
|
| arch | string | The architecture of the host (armhf, aarch64, i386, amd64) |
|
||||||
| content_trust | bool | If content-trust is enabled or disabled on the backend |
|
|
||||||
| force_security | bool | If force-security is enabled or disabled on the backend |
|
|
||||||
| channel | string | The active channel (stable, beta, dev) |
|
| channel | string | The active channel (stable, beta, dev) |
|
||||||
| timezone | string | The current timezone |
|
| timezone | string | The current timezone |
|
||||||
| healthy | bool | The supervisor is in a healthy state |
|
| healthy | bool | The supervisor is in a healthy state |
|
||||||
@ -2205,8 +2254,6 @@ Returns information about the supervisor
|
|||||||
"update_available": true,
|
"update_available": true,
|
||||||
"arch": "amd64",
|
"arch": "amd64",
|
||||||
"channel": "dev",
|
"channel": "dev",
|
||||||
"content_trust": true,
|
|
||||||
"force_security": false,
|
|
||||||
"timezone": "TIMEZONE",
|
"timezone": "TIMEZONE",
|
||||||
"healthy": true,
|
"healthy": true,
|
||||||
"supported": false,
|
"supported": false,
|
||||||
@ -2257,8 +2304,6 @@ You need to call `/supervisor/reload` after updating the options.
|
|||||||
| debug_block | bool | Enable debug block |
|
| debug_block | bool | Enable debug block |
|
||||||
| logging | string | Set logging level |
|
| logging | string | Set logging level |
|
||||||
| addons_repositories | list | Set a list of URL's as strings for add-on repositories |
|
| addons_repositories | list | Set a list of URL's as strings for add-on repositories |
|
||||||
| content_trust | bool | Disable/Enable content-trust |
|
|
||||||
| force_security | bool | Disable/Enable force-security |
|
|
||||||
|
|
||||||
</ApiEndpoint>
|
</ApiEndpoint>
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user