v3

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01251938.4 KB

apps

Install App

Install an app on an endpoint

post/apps/install

Query parameters

endpointIdinteger

Endpoint ID to install app on,if not set, install on the local endpoint

Request body

app_namestring required

The name of the app

app_idstring required

The custom identifier for the application. It must be a combination of 2 to 20 lowercase letters and numbers, and cannot start with a number.

proxy_enabledboolean required

Whether to enable proxy for the app:
If true,the app will be accessed through the proxy server,
If false, the app will be accessed through the port of the host machine.

domain_namesstring[] nullable required

The domain or IP for the app:
If proxy_enabled is true, provide the domain name.The first domain name will be used as the primary domain name.(e.g., ["wordpress.example1.com", "wordpress.example2.com"]) If proxy_enabled is false, provide the host machine's IP address.(e.g., ["192.168.1.1"])

settingsobject nullable

The settings for the app

Example request

{
  "app_name": "wordpress",
  "edition": {
    "dist": "community",
    "version": "1.0.0"
  },
  "app_id": "wordpress",
  "proxy_enabled": true,
  "domain_names": [
    "wordpress.example1.com",
    "wordpress.example2.com"
  ],
  "settings": {
    "W9_HTTP_PORT_SET": "9001"
  }
}

Response

Success

{"stackTrail":"paths:/apps/install:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}