# App Store API

Available since 2.5.0

# Refresh App Store

By refreshing app store, it will check the package index for new packages and available updates.

curl -X POST http://192.168.25.25:8090/app_store/services/refresh_store

# List Packages

Package list contain all packages and their update status.

curl -X GET http://192.168.25.25:8090/app_store/packages

Response

[
  {
    "name": "ax",
    "latest_version": "2.4.1-pi64",
    "current_version": "2.4.1-pi64",
    "status": "up_to_date"
  },
  {
    "name": "iot",
    "latest_version": "1.0.5",
    "current_version": "1.0.4",
    "status": "downloading",
    "download_task_id": 3
  },
  {
    "name": "package_manager",
    "latest_version": "0.3.2",
    "current_version": "0.3.0",
    "status": "installing",
    "install_task_id": 4
  }
]

type ListPackageResponse = Package[];

type PackageStatus =
  | 'not_installed'
  | 'upgradable'
  | 'downloading'
  | 'downloaded'
  | 'installing'
  | 'up_to_date'
  | 'download_queueing'
  | 'install_queueing'
  | 'download_failed'
  | 'install_failed';

interface Package {
  name: string;
  latest_version: string;
  current_version: string;
  status: PackageStatus;
  download_task_id?: number;
  install_task_id?: number;
}

# Download Packages

Before installation, packages must be downloaded first.

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"packages": ["ax", "py_axbot"]}' \
  http://192.168.25.25:8090/app_store/services/download_packages

Response

If failed, status code 400:

{
  "iot": "installed version(master) is already up to date",
  "some_random_package": "invalid module some_random_package, skip..."
}

If succeeded, status code 201:

{}

# Install Packages

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"packages": ["ax", "py_axbot"]}' \
  http://192.168.25.25:8090/app_store/services/install_packages

Response

If failed, status code 400:

{
  "ax": "installed version(master-pi64) is higher than downloaded version(2.4.1-pi64), skip...",
  "iot": "installed version(master) is higher than downloaded version(1.0.5), skip..."
}

If succeeded, status code 201:

{}

# Install Package from Local File

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"filename": "/tmp/ax.2.6.4.pi64.tar.gz"]}' \
  http://192.168.25.25:8090/app_store/services/install_local_file

Response

{
  "module_name": "ax",
  "version": "2.6.4"
}

# View Download/Installation Tasks

When downloading/installing packages, there are associated "download/install tasks". One can view logs of these tasks.

# for download tasks
curl http://192.168.25.25:8090/app_store/jobs/download/tasks
# for installation tasks
curl http://192.168.25.25:8090/app_store/jobs/install/tasks

```json
[
  {
    "id": 4,
    "status": "succeeded",
    "module": "iot",
    "version": "1.0.5",
    "create_time": "2023-05-04 17:21:36",
    "start_time": "2023-05-04 17:21:47",
    "end_time": "2023-05-04 17:21:50",
    "url": "http://192.168.25.25:8090/app_store/jobs/download/tasks/4/log"
  },
  {
    "id": 3,
    "status": "succeeded",
    "module": "ax",
    "version": "2.4.1-pi64",
    "create_time": "2023-05-04 17:21:36",
    "start_time": "2023-05-04 17:21:36",
    "end_time": "2023-05-04 17:21:47",
    "url": "http://192.168.25.25:8090/app_store/jobs/download/tasks/3/log"
  }
]

For a task, the logs of the task can be requested.

curl "http://192.168.25.25:8090/app_store/jobs/download/tasks/4/log"

But if the task is still in progress, the log will be incomplete.

With POST request, the log can be downloaded progressively, which is more suitable for realtime display.

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"start": 0, "end": 1024}' \
  http://192.168.25.25:8090/app_store/jobs/download/tasks/4/log

interface TaskLogRequest {
  // start character
  // If both start and end are missing, the whole file will be returned
  start?: number;

  end?: number; // end character, exclusive
}

The server will return additional response headers:

x-more-data - true means the log is incomplete, false otherwise.
x-text-size - Currently available characters of the whole file

← System Settings Host Name API →