apps_tool
Server scripts environment on the selected site (call select_site first). Not modules_tool (panel modules), not files_tool or ftp_tool (the site storefront). uAPI: status, activate, visitor encryption key, login keys. Environment (DirectAdmin): session, files, archives, MySQL, PHP/Node/Python, FTP, cron, account backup, phpMyAdmin SSO. Order: get_guide, status, ensure_ready (confirm only after the user approves creating the account). File paths are relative to the environment home. Do not prefix /home and do not invent folders from status.domain; use session selected_domain or files_list path=domains. The download link uses the technical domain public_html via https://{site}/apps/mcp_dl/.... Large and binary files return that public URL instead of bytes. SQL export/import returns a phpMyAdmin link and does not send the dump. Login key main is stored for this site and is not included in the response. MySQL names are prefixed with {username}. FTP create uses type=ftp. Cron delete uses select0 (cron_id from cron_list). confirm:true is required for activate, key rotation/deletion, file/db/app removal, cron/ftp deletion, backup, and legacy file edit.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Alias of key_id. | |
| hour | No | Cron hour. Default *. | |
| name | No | Database, database user, or FTP user short name. The username_ prefix is added for MySQL. | |
| path | No | Home-relative file path. Not /home/... . | |
| perm | No | Permission bits as a number, for example 644. | |
| user | No | FTP username without @domain. | |
| hosts | No | MySQL host patterns. | |
| limit | No | Listing limit. | |
| merge | No | mergeAndOverwrite for copy-to, move-to, and extract. | |
| month | No | Cron month. Default *. | |
| parts | No | Backup components: domain, database, ftp, email, subdomain. Default domain. | |
| paths | No | Home-relative paths for delete or chmod. | |
| query | No | File name query (files_search). | |
| trash | No | Move to trash instead of deleting. | |
| action | Yes | Operation. get_guide explains the order of calls. | |
| dbuser | No | MySQL user. Prefixed with {username}_ when missing. | |
| domain | No | Environment domain for an app, FTP account, or backup form. Defaults to selected_domain, not a file path. | |
| key_id | No | Login key id. Defaults to main on create. Letters and digits only. | |
| minute | No | Cron minute. Default 0. | |
| offset | No | Listing offset. | |
| params | No | Extra CloudLinux params. PHP extension changes were rejected on the uCoz test environment. | |
| plugin | No | CloudLinux plugin for selector: phpselector, nodejs_selector, python_selector. | |
| source | No | Home-relative source path. | |
| app_uri | No | Public path. /hello is served as https://{site}/apps/hello. | |
| charset | No | MySQL charset. | |
| command | No | Cron shell command. This path may be absolute /home/{username}/... . | |
| confirm | No | Required after explicit user approval for destructive actions and activate. | |
| content | No | UTF-8 file text for files_write, files_patch, or files_legacy_edit. | |
| cron_id | No | Cron id from cron_list, for example 000. Sent as select0. | |
| members | No | Archive member names. Empty means all. | |
| select0 | No | FTP account to delete: the short username from ftp_list. user@domain is accepted and the domain part is dropped. Also an alias of cron_id. | |
| sources | No | Home-relative paths for copy-to, move-to, or create-archive. | |
| version | No | PHP version (8.2, 8.3, native), Node version (default 22), or Python version (default 3.11). | |
| app_mode | No | Node only: development or production. Default production. Not sent for Python. | |
| app_root | No | Application directory relative to home, or /home/{username}/.... | |
| cron_ids | No | Several cron ids to delete (select0, select1, ...). | |
| database | No | MySQL database. Prefixed with {username}_ when missing. | |
| env_vars | No | Optional environment variables for a new Node or Python app. | |
| password | No | Password for a new DB user, FTP account, or DirectAdmin login key. Omit to let the environment generate a DB password. | |
| collation | No | MySQL collation. | |
| dayofweek | No | Cron day of week. Default *. | |
| overwrite | No | Overwrite on write/copy/move. files_write defaults to true. | |
| dayofmonth | No | Cron day of month. Default *. | |
| new_string | No | Replacement text (files_patch). | |
| old_string | No | Text to replace. Must occur once (files_patch). | |
| privileges | No | MySQL privilege map. Defaults to the full set on create. | |
| allow_login | No | DirectAdmin login key may open the panel. Defaults to false. confirm is required when true. | |
| destination | No | Home-relative destination path. | |
| entry_point | No | Python WSGI callable inside the startup file (CloudLinux entry-point), for example application. A value ending in .py is sent as startup-file when startup_file is omitted. | |
| interpreter | No | CloudLinux interpreter for selector: php, nodejs, or python. | |
| new_password | No | Replacement database password (at least 8 characters). | |
| startup_file | No | CloudLinux startup-file. Node default app.js. Python default passenger_wsgi.py. Required by the Python interpreter. | |
| deny_commands | No | DirectAdmin login key command deny list. | |
| allow_commands | No | DirectAdmin login key command allow list. | |
| allow_networks | No | DirectAdmin login key network allow list. | |
| destination_dir | No | Home-relative destination directory for copy-to, move-to, and extract. | |
| selector_method | No | CloudLinux method for selector: get, set, create, start, stop, restart, destroy, install-modules. | |
| current_password | No | Current password, only if a DirectAdmin login-key call requires it. |