Skip to main content

Store endpoints

Minimum role: manager for all /store paths. App icon and logo assets are exempt from token validation (they are frontend asset paths).

On the v1 tree store apps live under /store/addons; on /v2 under /store/apps. The v1 paths are shown; handlers are shared.

MethodPathRoleDescription
GET/storemanagerStore apps and repositories
POST/store/reloadmanagerReload all store repositories
GET/store/addonsmanagerAll store apps
GET/store/addons/{app}managerStore app details
GET/store/addons/{app}/{version}managerStore app details (by version path)
GET/store/addons/{app}/iconnoneApp icon (image/png)
GET/store/addons/{app}/logononeApp logo (image/png)
GET/store/addons/{app}/changelogmanagerChangelog (text/plain)
GET/store/addons/{app}/documentationmanagerDocumentation (text/plain)
GET/store/addons/{app}/availabilitymanagerEmpty success if installable on this system
POST/store/addons/{app}/installmanagerInstall app
POST/store/addons/{app}/install/{version}managerInstall specific version
POST/store/addons/{app}/updatemanagerUpdate app
POST/store/addons/{app}/update/{version}managerUpdate to specific version
GET/store/repositoriesmanagerList repositories
GET/store/repositories/{repository}managerRepository details
POST/store/repositoriesmanagerAdd a repository
DELETE/store/repositories/{repository}managerRemove a repository
POST/store/repositories/{repository}/repairmanagerReset a broken repository checkout

GET /store

Response data: addons (v2: apps) — list of store app objects — and repositories.

Store app object: advanced, arch, available, build, description, documentation, apexos (minimum Core version), icon, installed, logo, name, repository, slug, stage, update_available, url, version_latest, version (installed version or null).

GET /store/addons/{app} additionally includes: apparmor, auth_api, detached, docker_api, full_access, supervisor_api, supervisor_role, apexos_api, host_network, host_pid, ingress, long_description, rating, signed.

Repository object: slug, name, source, url, maintainer.

POST /store/addons/{app}/install[/{version}]

FieldTypeDefaultDescription
backgroundbooleanfalseReturn immediately with job_id

POST /store/addons/{app}/update[/{version}]

FieldTypeDefaultDescription
backupbooleanCreate a partial backup before updating
backgroundbooleanfalseReturn immediately with job_id

An app cannot update itself; such requests are rejected.

POST /store/repositories

FieldTypeRequired
repositoryrepository URLyes

Legacy aliases under /addons

The v1 tree also registers these store handlers under the installed-apps prefix:

MethodPathSame as
POST/addons/reload/store/reload
POST/addons/{app}/install/store/addons/{app}/install
POST/addons/{app}/update/store/addons/{app}/update
GET/addons/{app}/icon/store/addons/{app}/icon
GET/addons/{app}/logo/store/addons/{app}/logo
GET/addons/{app}/changelog/store/addons/{app}/changelog
GET/addons/{app}/documentation/store/addons/{app}/documentation