app

---

app

Syscap: app
Package: container
Type: Directory

Flag	Name	Description
X	disabled	Application is disabled (not downloaded/installed or downloaded but disabled)
R	running	Application is actively running and accessible
c	custom	Custom application created by the user
s	from-app-store	Application installed from a custom app store

Argument	Type	Description
container-command-lines	object { composite { , } { , } }	Specifies the command-line argument(s) to pass to the application when starting the container
auto-update	bool	Enables or disables automatic updating when a new container image version is available
use-https	bool	Uses HTTPS for the application URL. This option will not work on devices that do not support cloud services
network	enum (default)	Specifies which network the container will use: internal (behind NAT), lan (on the LAN network), or default (varies per application)
network-pvid	num	Sets the Port VLAN ID (PVID) for the container's virtual Ethernet interface in the bridge
network-outgoing-access	bool	Allows network outgoing access for the specific container app. When set to no, a mangle drop rule is created
firewall-redirects	object { composite { , } { , } }	Configures port redirection from the host device to the container
yaml	string	Provides the YAML composition for the application. See the documentation for configuration examples
required-mounts	object { composite { , } { , } }	Mount directories required for the container to start. Format: [dir-on-host]:[dir-in-app]
extra-mounts	object { composite { , } { , } }	Specifies additional mount points to attach to the container
environment	object { super { ! , composite { , } { , } } { ! , composite { , } { , } } }	Defines environment variables to be available to the running application. Specify as a list of key-value pair(s)
secrets	object { composite { , } { , } }
required-hw-devices	object { composite { , } { , } }	Hardware devices that must be present on the host for the container to start. Format: [host-hw-device]:[device-in-app]
devices	object { composite { , } { , } }	Specifies additional hardware devices to pass through to the container application

Read-only Argument	Type	Description
app-store-url	string	The URL of the app store from which the application was installed
name	string	The application name as defined in the YAML configuration
description	string	The application description as defined in the YAML configuration
project-page	string	The application project page URL as defined in the YAML configuration
category	string	Application functional classification
ui-url	string	The generated URL for the application web interface, if available
default-credentials	string	The default credentials required for the application
status	string	The current status of the application (acquire veth, configuring container(s), downloading/extracting, starting)
default-network	enum	The default network used by the application (lan or internal)
interface	iface_enum { none:nv::BADID }	The VETH interface used by the application
ip-address	ipAddr	The IP address assigned to the VETH interface
cmds	multi { string }
cpu-usage	num	The current CPU usage percentage by the application
memory-current	num	The amount of memory currently used by the application
app-size	num	The total size of the application
data-size	num	The size of the data stored by the application
configs	object { composite { , } { , } }
variables-to-use-in-environment	object { composite { , } { , } }	A list of all variables present in the application environment

app/cleanup

Package: container
Type: Command

Removes all application data, configuration files, and the container image. This operation is destructive and irreversible.

app/network

Package: container
Type: Directory

Flag	Name	Description
e	external
I	invalid

Argument	Type	Description
name	string
allow-outgoing-access	bool

Read-only Argument	Type	Description
network	ipAddr
ip	ipAddr
status	string
used-ips	multi { array-id, array-id, composite { , } { , } }
bridge-interface	iface_enum { none:nv::BADID }
cmds	multi { string }

app/remove

Package: container
Type: Command

Removes the specified application from the system.

app/restart

Package: container
Type: Command

Restarts the specified running application.

app/settings

Package: container
Type: Settings Directory

Argument	Type	Description
disk	enum (none)	Global setting that specifies which disk will be used for storage operations
router-ip	ipAddr	Manually specifies the IP address at which the current RouterOS device can be reached
lan-bridge	iface_enum { none:nv::BADID }	Manually specifies the bridge interface that represents the local area network
media-path	file	Manually specifies the directory path where all media files will be stored
download-path	file	Manually specifies the directory path where all downloaded content will be stored
show-in-webfig	bool	Controls whether links to enabled applications are displayed on the WebFig login page
auto-update	bool	Global setting that enables automatic updates for all installed applications packages
registry-mirrors	multi { array-id, array-id, composite { , } { , } }	Specifies one or more registry mirror URLs for container image retrieval
app-store-urls	multi { array-id, string }	URL to a custom app store. Must point to a YAML array where each application is an element

Read-only Argument	Type	Description
assumed-router-ip	ipAddr	Automatically detected network IP address of the RouterOS device
assumed-lan-bridge	iface_enum { none:nv::BADID }	Automatically detected bridge interface used for LAN connectivity
assumed-media-path	file	Default media storage path, typically located on the system disk
assumed-download-path	file	Default download directory path, typically located within the media storage area
certificate-status	string
certificate	enum (none)

app/setup

Package: container
Type: Command

Starts the setup wizard that automates networking, storage, and registry configuration for the App system.

Read-only Argument	Type	Description
disk	enum (none)	Selected storage disk for application installation
lan-bridge	iface_enum { none:nv::BADID }	Selected LAN bridge interface for container networking
router-ip-alt	alt { enum , ipAddr }	Manual IP address override for the RouterOS device

app/update

Package: container
Type: Command

Updates the specified application to the latest available container image.