---
title: "Install App"
method: POST
path: "/apps/install"
tags: ["apps"]
---

# Install App

`POST /apps/install`

Install an app on an endpoint

## Query parameters

- `endpointId` integer — Endpoint ID to install app on,if not set, install on the local endpoint

## Request body

- AppInstall
  - `app_name` string, required — The name of the app
  - `edition` Edition, required
    - `dist` string, required — The edition of the app
    - `version` string, required — The version of the app
  - `app_id` string, 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_enabled` boolean, 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_names` string[], 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"])
  - `settings` object, nullable — The settings for the app

## Response `200`

Success

- unknown

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

[API](https://skmtc.dev/websoft9/apis/appmanae-api.md) · [All operations](https://skmtc.dev/websoft9/apis/appmanae-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/websoft9/appmanae-api/revisions/e4bf692cc15e/schema)