Skip to content

Document background addon install/update option #2775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 12, 2025
Merged

Document background addon install/update option #2775

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/api/supervisor/endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3229,6 +3229,12 @@ Returns information about a store add-on

Install an add-on from the store.

**Payload:**

| key | type | description |
| ---------- | ------- | --------------------------------------------------------------------------------------------------- |
| background | boolean | Return `job_id` immediately, do not wait for install to complete. Clients must check job for status |

</ApiEndpoint>

<ApiEndpoint path="/store/addons/<addon>/update" method="post">
Expand All @@ -3237,9 +3243,10 @@ Update an add-on from the store.

**Payload:**

| key | type | description |
| ------- | ------ | -------------------------------------------------------------- |
| backup | boolean | Create a partial backup of the add-on, default is false |
| key | type | description |
| ---------- | ------- | -------------------------------------------------------------------------------------------------- |
| backup | boolean | Create a partial backup of the add-on, default is false |
| background | boolean | Return `job_id` immediately, do not wait for update to complete. Clients must check job for status |

</ApiEndpoint>

Expand Down