Easypanel

https://easypanel.io/docs
Admin
Easypanel is a Docker-based server management panel for deploying and managing applications and...
Tokens:201,314
Snippets:2,329
Trust Score:9.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### Get setup status

Source: https://easypanel.io/docs/api/endpoints

Returns whether the initial Easypanel setup has been completed.

```APIDOC
## GET /api/setup/status

### Description
Reports whether initial Easypanel setup has been completed.

### Method
GET

### Endpoint
/api/setup/status

```

--------------------------------

### cURL request to get setup status

Source: https://easypanel.io/docs/api/setup/getSetupStatus

Sends a GET request to the /getSetupStatus endpoint with a bearer token. The response is null when setup has not been completed.

```cURL
curl -X GET "https://demo.easypanel.io/api/getSetupStatus" \
  -H "Authorization: Bearer "
```

--------------------------------

### Install Easypanel with the script

Source: https://easypanel.io/docs

Run as root on a fresh Ubuntu server with at least 2 GB RAM and ports 80 and 443 available. The script installs Docker when needed, initializes Docker Swarm, and starts Easypanel.

```bash
curl -sSL https://get.easypanel.io | sh
```

--------------------------------

### GET /getSetupStatus

Source: https://easypanel.io/docs/api/setup/getSetupStatus

Reports whether initial Easypanel setup has been completed. Requires bearer authentication.

```APIDOC
## GET /getSetupStatus

### Description
Reports whether initial Easypanel setup has been completed.

### Method
GET

### Endpoint
`https://demo.easypanel.io/api/getSetupStatus`

### Authorization
`bearerAuth` - Bearer token in header

### Response
#### Success Response (200)
Returns `null` when setup is complete.

#### Response Example
```json
null
```
```

--------------------------------

### Install Easypanel with Docker (Stable and Canary)

Source: https://easypanel.io/docs

Run after Docker is installed. Requires root (sudo) privileges. The command mounts the Easypanel config directory and the Docker socket, then runs the setup. The Stable and Canary tabs show the same command.

```bash
docker run --rm -it \
  -v /etc/easypanel:/etc/easypanel \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  easypanel/easypanel setup
```

--------------------------------

### Get demo mode GET

Source: https://easypanel.io/docs/api/endpoints

Returns whether this Easypanel installation is running in demo mode.

```APIDOC
## GET Get demo mode

### Description
Returns whether this Easypanel installation is running in demo mode.

### Method
GET

### Endpoint
Get demo mode
```

--------------------------------

### Install shell completion

Source: https://easypanel.io/docs/cli

Installs dynamic completion for Bash, Zsh, Fish, or PowerShell. Completion uses the current server's command manifest and suggests commands, flags, enum values, projects, and services. Start a new shell after installing.

```bash
easypanel completion install
```

--------------------------------

### Install the Easypanel CLI with curl

Source: https://easypanel.io/docs/cli

Downloads and runs the official installer script. The installer selects the correct AMD64 or ARM64 binary and verifies its SHA-256 checksum. Set EASYPANEL_CLI_VERSION before running to install a specific release.

```bash
curl -fsSL https://get.easypanel.io/cli | sh
```

--------------------------------

### Install Docker

Source: https://easypanel.io/docs

Easypanel is powered by Docker, so install Docker first. Most cloud providers have server images with Docker preinstalled.

```bash
curl -sSL https://get.docker.com | sh
```

--------------------------------

### Confirm the Easypanel CLI installation

Source: https://easypanel.io/docs/cli

Prints the installed CLI version. Run after installation to verify the CLI is available.

```bash
easypanel version
```

--------------------------------

### Install NVIDIA Container Toolkit

Source: https://easypanel.io/docs/guides/gpu-support

Run these commands on each GPU node to add the repository, update package lists, and install the toolkit.

```bash
# Add the NVIDIA Container Toolkit repository
curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg \
&& curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list | \
sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | \
sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list

# Update the package lists
sudo apt-get update

# Install NVIDIA Container Toolkit
sudo apt-get install -y nvidia-container-toolkit
```

--------------------------------

### Start PostgreSQL service

Source: https://easypanel.io/docs/api/endpoints

Enables and starts a PostgreSQL service.

```APIDOC
## POST Start PostgreSQL service

### Description
Enables and starts a PostgreSQL service.

### Method
POST

### Endpoint
Not specified in source.
```

--------------------------------

### Example backup destination path

Source: https://easypanel.io/docs/backups/database

Example destination path for a backup configuration. Use a unique destination path for each database and configuration to avoid conflicts.

```text
production/orders-postgres
```

--------------------------------

### Start MySQL service

Source: https://easypanel.io/docs/api/endpoints

Enables and starts a MySQL service.

```APIDOC
## POST Start MySQL service

### Description
Enables and starts a MySQL service.

### Method
POST

### Endpoint
Not specified in source.
```

--------------------------------

### Install a WordPress plugin

Source: https://easypanel.io/docs/api/endpoints

Installs and activates a plugin for a WordPress site.

```APIDOC
## POST /services/wordpress/plugins/install

### Description
Installs and activates a plugin for a WordPress site.

### Method
POST

### Endpoint
/services/wordpress/plugins/install
```

--------------------------------

### Start Redis service

Source: https://easypanel.io/docs/api/endpoints

Enables and starts a Redis service.

```APIDOC
## POST /services/redis/start

### Description
Enables and starts a Redis service.

### Method
POST

### Endpoint
/services/redis/start
```

--------------------------------

### Install django-environ

Source: https://easypanel.io/docs/quickstarts/django

Install the django-environ package to manage environment variables in Django.

```bash
pip install django-environ
```

--------------------------------

### Environment Variables Example

Source: https://easypanel.io/docs/services/wordpress

Example of environment variables using .env syntax, available to the WordPress container. Restart or redeploy after changing values. Store secrets in Easypanel instead of committing them to Git.

```plaintext
WP_ENV=production
CUSTOM_API_KEY=change-me
```

--------------------------------

### Set up Easypanel

Source: https://easypanel.io/docs/api/endpoints

Initializes the Easypanel instance by creating the first administrator and applying configuration.

```APIDOC
## POST /api/setup

### Description
Creates the initial administrator and configures the Easypanel instance.

### Method
POST

### Endpoint
/api/setup

```

--------------------------------

### Get Docker version GET

Source: https://easypanel.io/docs/api/endpoints

Returns the Docker engine version installed on the server.

```APIDOC
## GET Get Docker version

### Description
Returns the Docker engine version installed on the server.

### Method
GET

### Endpoint
Get Docker version
```

--------------------------------

### cURL request to get basic branding settings

Source: https://easypanel.io/docs/api/branding/getBasicSettings

Sends a GET request to the /getBasicSettings endpoint with a bearer token. The response contains the server name, color, and basic interface visibility settings.

```bash
curl -X GET "https://demo.easypanel.io/api/getBasicSettings" \
  -H "Authorization: Bearer "
```

--------------------------------

### cURL request to get service domain

Source: https://easypanel.io/docs/api/settings/getServiceDomain

Sends a GET request to the getServiceDomain endpoint with bearer authentication. The response body is shown as null in the example.

```bash
curl -X GET "https://demo.easypanel.io/api/getServiceDomain" \
  -H "Authorization: Bearer "
```

--------------------------------

### cURL request to GET /getAdvancedStats

Source: https://easypanel.io/docs/api/legacy-monitoring/getAdvancedStats

Sends a GET request to the Easypanel API endpoint /getAdvancedStats with an Authorization header. The bearer token is empty in the example.

```bash
curl -X GET "https://demo.easypanel.io/api/getAdvancedStats" \
  -H "Authorization: Bearer "
```

--------------------------------

### POST /startAppService

Source: https://easypanel.io/docs/api/services/app/startAppService

Starts an application service by providing the project name and service name.

```APIDOC
## POST /startAppService

### Description
Enables and starts an application service.

### Method
POST

### Endpoint
`/startAppService`

### Authorization
`bearerAuth` - Bearer token in header

### Parameters
#### Request Body
- **projectName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **serviceName** (string) - Required - Must match `^[a-z0-9-_]+$`

### Request Example
```json
{
  "projectName": "string",
  "serviceName": "string"
}
```

### Response
#### Success Response (200)
Returns `null`.

#### Response Example
```json
null
```
```

--------------------------------

### cURL request to get metrics settings

Source: https://easypanel.io/docs/api/metrics/getMetricsSettings

Sends a GET request to the /getMetricsSettings endpoint with bearer token authorization. The response body is shown as null in the example.

```bash
curl -X GET "https://demo.easypanel.io/api/getMetricsSettings" \
  -H "Authorization: Bearer "
```

--------------------------------

### cURL request to get error page settings

Source: https://easypanel.io/docs/api/branding/getErrorPageSettings

Sends a GET request to the getErrorPageSettings endpoint with bearer authentication. The response is a JSON object (null in the example).

```bash
curl -X GET "https://demo.easypanel.io/api/getErrorPageSettings" \
  -H "Authorization: Bearer "
```

--------------------------------

### POST /services/apps/{id}/start

Source: https://easypanel.io/docs/api/endpoints

Starts the application service, enabling it if it was disabled.

```APIDOC
## POST /services/apps/{id}/start

### Description
Enables and starts an application service.

### Method
POST

### Endpoint
/services/apps/{id}/start
```

--------------------------------

### cURL request to GET /onInvalidateActions

Source: https://easypanel.io/docs/api/subscription/onInvalidateActions

Sends a GET request to the endpoint with a bearer token in the Authorization header. The token is empty in the example and must be replaced with a valid one.

```bash
curl -X GET "https://demo.easypanel.io/api/onInvalidateActions" \
  -H "Authorization: Bearer "
```

--------------------------------

### GET /getWordPressPlugins

Source: https://easypanel.io/docs/api/services/wordpress/getWordPressPlugins

Lists installed WordPress plugins, versions, status, and available updates.

```APIDOC
## [GET] /getWordPressPlugins

### Description
Lists installed WordPress plugins, versions, status, and available updates.

### Method
GET

### Endpoint
/getWordPressPlugins

### Parameters
#### Query Parameters
- **projectName** (string) - Required - The project name. Must match `^[a-z0-9-_]+$`.
- **serviceName** (string) - Required - The service name. Must match `^[a-z0-9-_]+$`.

### Request Example
```
curl -X GET "https://demo.easypanel.io/api/getWordPressPlugins?projectName=string&serviceName=string" \
  -H "Authorization: Bearer "
```

### Response
#### Success Response (200)
- **body** (null) - The response body is null.

#### Response Example
```
null
```
```

--------------------------------

### GET /getBasicSettings

Source: https://easypanel.io/docs/api/branding/getBasicSettings

Returns the server name, color, and basic interface visibility settings. Requires bearer token authentication.

```APIDOC
## GET /getBasicSettings

### Description
Returns the server name, color, and basic interface visibility settings.

### Method
GET

### Endpoint
`/getBasicSettings`

### Parameters
#### Authorization
- **bearerAuth** (string) - Required - Bearer token for authentication. Provided in the `Authorization` header.

### Request Example
```
curl -X GET "https://demo.easypanel.io/api/getBasicSettings" \
  -H "Authorization: Bearer "
```

### Response
#### Success Response (200)
- **body** (null) - The response body is null.

#### Response Example
```
null
```
```

--------------------------------

### Verify NVIDIA Container Toolkit installation

Source: https://easypanel.io/docs/guides/gpu-support

Runs a test container with GPU access to verify the toolkit is working. You should see the output of nvidia-smi showing your GPU(s).

```bash
sudo docker run --rm --gpus all nvidia/cuda:11.6.2-base-ubuntu20.04 nvidia-smi
```

--------------------------------

### cURL request to get exposed image ports

Source: https://easypanel.io/docs/api/services/app/getAppExposedPorts

Sends a GET request to the getAppExposedPorts endpoint with an Authorization header. The token is empty in the example, so a valid bearer token must be provided.

```bash
curl -X GET "https://demo.easypanel.io/api/getAppExposedPorts" \
  -H "Authorization: Bearer "
```

--------------------------------

### cURL request to get log aggregation resource usage

Source: https://easypanel.io/docs/api/logs/getLogsStats

Sends a GET request to the /getLogsStats endpoint with bearer authentication. The response body is a JSON object, shown as null in the example.

```bash
curl -X GET "https://demo.easypanel.io/api/getLogsStats" \
  -H "Authorization: Bearer "
```

--------------------------------

### POST /runDatabaseBackup

Source: https://easypanel.io/docs/api/database-backups/runDatabaseBackup

Starts an authorized database backup immediately.

```APIDOC
## POST /runDatabaseBackup

### Description
Starts an authorized database backup immediately.

### Method
POST

### Endpoint
/runDatabaseBackup

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **id** (string) - Required - The ID of the database to back up.
- **name** (string) - Optional - A name for the backup.

### Request Example
{
  "id": "string"
}

### Response
#### Success Response (200)
- **body** (null) - The response body is null.

#### Response Example
null
```

--------------------------------

### cURL request to GET /getUser

Source: https://easypanel.io/docs/api/authentication/getUser

Sends a GET request to the Easypanel API endpoint /getUser with a bearer token in the Authorization header. The token is empty in the example and must be replaced with a valid token.

```bash
curl -X GET "https://demo.easypanel.io/api/getUser" \
  -H "Authorization: Bearer "
```

--------------------------------

### cURL request to getLegacyMonitorSystemStats

Source: https://easypanel.io/docs/api/legacy-monitoring/getLegacyMonitorSystemStats

Sends a GET request to the endpoint with an Authorization header. The token is empty in the example.

```bash
curl -X GET "https://demo.easypanel.io/api/getLegacyMonitorSystemStats" \
  -H "Authorization: Bearer "
```

--------------------------------

### cURL request to POST /setup

Source: https://easypanel.io/docs/api/setup/setup

Creates the initial administrator and configures the Easypanel instance. Requires a bearer token in the Authorization header. The request body must include email, password (at least 8 characters), source, subscribe, and terms.

```bash
curl -X POST "https://demo.easypanel.io/api/setup" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "stringst",
    "source": "string",
    "subscribe": true,
    "terms": true
  }'
```

--------------------------------

### Supply API key via EASYPANEL_API_KEY for CI

Source: https://easypanel.io/docs/cli

For CI, supply the API key through `EASYPANEL_API_KEY` instead of saving it in a credential manager. The example sets the server and API key as environment variables for a single command.

```bash
EASYPANEL_SERVER=production \
EASYPANEL_API_KEY="$CI_EASYPANEL_API_KEY" \
easypanel projects list --format json
```

--------------------------------

### POST /initWordPressService

Source: https://easypanel.io/docs/api/services/wordpress/initWordPressService

Initializes WordPress files, Git content, and the configured database service.

```APIDOC
## [POST] /initWordPressService

### Description
Initializes WordPress files, Git content, and the configured database service.

### Method
POST

### Endpoint
`/initWordPressService`

### Authorization
`bearerAuth` - Bearer token in the `Authorization` header.

### Parameters
#### Request Body
- **projectName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **serviceName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **databaseService** (string) - Optional
- **git** (object) - Optional
- **private** (boolean) - Optional - Default: `true`

### Request Example
```json
{
  "projectName": "string",
  "serviceName": "string"
}
```

### Response
#### Success Response (200)
Returns `null`.

#### Response Example
```json
null
```
```

--------------------------------

### cURL request to list notification channels

Source: https://easypanel.io/docs/api/notifications/listNotificationChannels

Sends a GET request to the /listNotificationChannels endpoint with a bearer token. The response is a JSON object (null in the example).

```cURL
curl -X GET "https://demo.easypanel.io/api/listNotificationChannels" \
  -H "Authorization: Bearer "
```

--------------------------------

### cURL example for GET /getLetsEncryptEmail

Source: https://easypanel.io/docs/api/settings/getLetsEncryptEmail

Use this cURL command to retrieve the Let's Encrypt email. Replace the empty Bearer token with your actual token.

```bash
curl -X GET "https://demo.easypanel.io/api/getLetsEncryptEmail" \
  -H "Authorization: Bearer "
```

--------------------------------

### Connect an Easypanel server with easypanel server add

Source: https://easypanel.io/docs/cli

Adds a server profile named `production` for the given URL. The CLI prompts for the API key, which is read without echoing. The new profile becomes the current server. Profile names may contain letters, numbers, dashes, or underscores.

```bash
easypanel server add production https://panel.example.com
```

--------------------------------

### cURL request to check Docker updates

Source: https://easypanel.io/docs/api/settings/checkDockerUpdate

Sends a GET request to the checkDockerUpdate endpoint with a Bearer token. The token is empty in the example; replace it with a valid token.

```bash
curl -X GET "https://demo.easypanel.io/api/checkDockerUpdate" \
  -H "Authorization: Bearer "
```

--------------------------------

### Show CLI help with easypanel --help

Source: https://easypanel.io/docs/cli

Displays the available command tree or help for a specific command. Use `easypanel --help`, `easypanel projects --help`, or `easypanel app inspect --help`.

```bash
easypanel --help
```

```bash
easypanel projects --help
```

```bash
easypanel app inspect --help
```

--------------------------------

### POST /lemon-license/activate

Source: https://easypanel.io/docs/api/endpoints

Activates this Easypanel instance using a Lemon Squeezy license key.

```APIDOC
## POST /lemon-license/activate

### Description
Activates this Easypanel instance using a Lemon Squeezy license key.

### Method
POST

### Endpoint
/lemon-license/activate
```

--------------------------------

### cURL request to getMonitorTableData

Source: https://easypanel.io/docs/api/legacy-monitoring/getMonitorTableData

Sends a GET request to the getMonitorTableData endpoint with a bearer token in the Authorization header. The token is empty in the example and must be replaced with a valid token.

```bash
curl -X GET "https://demo.easypanel.io/api/getMonitorTableData" \
  -H "Authorization: Bearer "
```

--------------------------------

### List storage providers with cURL

Source: https://easypanel.io/docs/api/storage-providers/common/listStorageProviders

Sends a GET request to the listStorageProviders endpoint with a bearer token in the Authorization header. The token is empty in the example and must be replaced with a valid token.

```cURL
curl -X GET "https://demo.easypanel.io/api/listStorageProviders" \
  -H "Authorization: Bearer "
```

--------------------------------

### POST /initBoxService

Source: https://easypanel.io/docs/api/services/box/initBoxService

Initializes service storage and optionally clones the configured Git repository.

```APIDOC
## POST /initBoxService

### Description
Initializes service storage and optionally clones the configured Git repository.

### Method
POST

### Endpoint
`/initBoxService`

### Authorization
- **bearerAuth** (header) - Required - Bearer token for authentication.

### Request Body
`application/json`

- **projectName** (string) - Required - Must match `^[a-z0-9-_]+$`.
- **serviceName** (string) - Required - Must match `^[a-z0-9-_]+$`.
- **git** (object) - Optional - Git configuration.
  - **private** (boolean) - Optional - Default `true`.

### Request Example
```json
{
  "projectName": "string",
  "serviceName": "string"
}
```

### Response
#### Success Response (200)
Returns `null`.

#### Response Example
```json
null
```
```

--------------------------------

### POST /createAppService

Source: https://easypanel.io/docs/api/services/app/createAppService

Creates an application service and deploys it when a source is configured. Requires authentication and a JSON body with projectName and serviceName.

```APIDOC
## [POST] /createAppService

### Description
Creates an application service and deploys it when a source is configured.

### Method
POST

### Endpoint
`/createAppService`

### Authorization
- **bearerAuth** (header) - Required - Bearer token for authentication.

### Parameters
#### Request Body
- **projectName** (string) - Required - Must match pattern `^[a-z0-9-_]+$`.
- **serviceName** (string) - Required - Must match pattern `^[a-z0-9-_]+$`.
- **basicAuth** (array<object>) - Optional - Basic authentication settings.
- **build** (object|object|object|object|object|object) - Optional - Build configuration.
- **deploy** (object) - Optional - Deployment settings. Default: `{}`.
- **domains** (array<object>) - Optional - Domain settings. Default: `[]`.
- **dotEnvPath** (string) - Optional - Path to .env file. Length must be >= 1.
- **env** (string) - Optional - Environment variables. Default: `""`.
- **maintenance** (object) - Optional - Maintenance mode settings.
- **mounts** (array<object|object|object>) - Optional - Mount configurations. Default: `[]`.
- **ports** (array<object>) - Optional - Port mappings. Default: `[]`.
- **resources** (object) - Optional - Resource limits.
- **scripts** (array<object>) - Optional - Scripts to run.
- **source** (object|object|object|object|object) - Optional - Source configuration.

### Request Example
```json
{
  "projectName": "string",
  "serviceName": "string"
}
```

### Response
#### Success Response (200)
- Returns `null`.

#### Response Example
```json
null
```

```

--------------------------------

### cURL request to list Compose containers

Source: https://easypanel.io/docs/api/services/compose/getComposeDockerServices

Sends a GET request to the getComposeDockerServices endpoint with an Authorization header. The token is empty in the example, so you must replace it with a valid bearer token.

```bash
curl -X GET "https://demo.easypanel.io/api/getComposeDockerServices" \
  -H "Authorization: Bearer "
```

--------------------------------

### cURL request to list projects

Source: https://easypanel.io/docs/api/projects/listProjects

Sends a GET request to the listProjects endpoint with a bearer token in the Authorization header. The token is empty in the example and must be replaced with a valid token.

```bash
curl -X GET "https://demo.easypanel.io/api/listProjects" \
  -H "Authorization: Bearer "
```

--------------------------------

### POST /installWordPressTheme

Source: https://easypanel.io/docs/api/services/wordpress/installWordPressTheme

Installs and activates a theme for a WordPress site. Requires authentication and a request body with projectName, serviceName, and name.

```APIDOC
## POST /installWordPressTheme

### Description
Installs and activates a theme for a WordPress site.

### Method
POST

### Endpoint
/installWordPressTheme

### Authorization
bearerAuth
- **Authorization** (string) - Required - Bearer token in header

### Parameters
#### Request Body
- **projectName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **serviceName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **name** (string) - Required - Theme name

### Request Example
{
  "projectName": "string",
  "serviceName": "string",
  "name": "string"
}

### Response
#### Success Response (200)
- **body** (null) - No content

#### Response Example
null
```

--------------------------------

### cURL request to list Box presets

Source: https://easypanel.io/docs/api/services/box/listBoxPresets

Sends a GET request to the /listBoxPresets endpoint with a Bearer token in the Authorization header. The token is empty in the example and must be replaced with a valid token.

```bash
curl -X GET "https://demo.easypanel.io/api/listBoxPresets" \
  -H "Authorization: Bearer "
```

--------------------------------

### GET /getWordPressThemes

Source: https://easypanel.io/docs/api/services/wordpress/getWordPressThemes

Lists installed WordPress themes, versions, status, and available updates for a given project and service. Requires bearer token authentication and query parameters for project and service names.

```APIDOC
## GET /getWordPressThemes

### Description
Lists installed WordPress themes, versions, status, and available updates.

### Method
GET

### Endpoint
`/getWordPressThemes`

### Parameters
#### Query Parameters
- **projectName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **serviceName** (string) - Required - Must match `^[a-z0-9-_]+$`

### Authorization
`bearerAuth` - Bearer token in header

### Request Example
```
curl -X GET "https://demo.easypanel.io/api/getWordPressThemes?projectName=string&serviceName=string" \
  -H "Authorization: Bearer "
```

### Response
#### Success Response (200)
Response body is `null` in the example.

#### Response Example
```
null
```
```

--------------------------------

### POST /projects/create

Source: https://easypanel.io/docs/api/endpoints

Creates an empty project and its isolated Docker network.

```APIDOC
## POST /projects/create

### Description
Creates an empty project and its isolated Docker network.

### Method
POST

### Endpoint
/projects/create
```

--------------------------------

### Run a command against a specific server profile with --server

Source: https://easypanel.io/docs/cli

Use `--server` or `-s` to run a single command against a profile without changing the default. The example lists projects on the 'staging' profile.

```bash
easypanel --server staging projects list
```

--------------------------------

### POST /startComposeService

Source: https://easypanel.io/docs/api/services/compose/startComposeService

Enables and starts a Compose service. Requires project name and service name in the request body, and bearer token authentication.

```APIDOC
## POST /startComposeService

### Description
Enables and starts a Compose service.

### Method
POST

### Endpoint
https://demo.easypanel.io/api/startComposeService

### Authorization
bearerAuth - Bearer <token> - In: header

### Parameters
#### Request Body (application/json)
- **projectName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **serviceName** (string) - Required - Must match `^[a-z0-9-_]+$`

### Request Example
```json
{
  "projectName": "string",
  "serviceName": "string"
}
```

### Response
#### Success Response (200)
- Returns `null`

#### Response Example
```json
null
```

```

--------------------------------

### POST /cloudflare/tunnel/start

Source: https://easypanel.io/docs/api/endpoints

Starts the configured Cloudflare tunnel service.

```APIDOC
## POST /cloudflare/tunnel/start

### Description
Starts the configured Cloudflare tunnel service.

### Method
POST

### Endpoint
/cloudflare/tunnel/start
```

--------------------------------

### Create custom.yaml with nano

Source: https://easypanel.io/docs/guides/custom-traefik-config

Open or create the custom.yaml file in the Traefik config directory using the nano text editor. Replace 'nano' with vim or emacs if preferred.

```bash
sudo nano /etc/easypanel/traefik/config/custom.yaml
```

--------------------------------

### GET Get storage statistics

Source: https://easypanel.io/docs/api/endpoints

Returns host storage usage statistics.

```APIDOC
## GET Get storage statistics

### Description
Returns host storage usage statistics.

### Method
GET

### Endpoint
Not specified in the source.

```

--------------------------------

### GET /projects/inspect

Source: https://easypanel.io/docs/api/endpoints

Returns a project with its services and resolved domain configuration.

```APIDOC
## GET /projects/inspect

### Description
Returns a project with its services and resolved domain configuration.

### Method
GET

### Endpoint
/projects/inspect
```

--------------------------------

### Run a volume backup POST

Source: https://easypanel.io/docs/api/endpoints

Starts an authorized service volume backup immediately.

```APIDOC
## POST /run-volume-backup

### Description
Starts an authorized service volume backup immediately.

### Method
POST

### Endpoint
/run-volume-backup

```

--------------------------------

### Get telemetry setting GET

Source: https://easypanel.io/docs/api/endpoints

Returns whether anonymous Easypanel telemetry is disabled.

```APIDOC
## GET Get telemetry setting

### Description
Returns whether anonymous Easypanel telemetry is disabled.

### Method
GET

### Endpoint
Get telemetry setting
```

--------------------------------

### Use --format json for machine-readable output

Source: https://easypanel.io/docs/cli

Pass `--format json` for machine-readable output and `--yes` for an intentionally approved destructive operation. The example shows listing projects and deploying an app with JSON output.

```bash
easypanel projects list --format json
easypanel --server production app deploy my-project/web --format json
```

--------------------------------

### Get the GitHub token GET

Source: https://easypanel.io/docs/api/endpoints

Returns the GitHub access token stored by Easypanel.

```APIDOC
## GET Get the GitHub token

### Description
Returns the GitHub access token stored by Easypanel.

### Method
GET

### Endpoint
Get the GitHub token
```

--------------------------------

### GET Get service statistics

Source: https://easypanel.io/docs/api/endpoints

Returns live resource statistics for an authorized service.

```APIDOC
## GET Get service statistics

### Description
Returns live resource statistics for an authorized service.

### Method
GET

### Endpoint
Not specified in the source.

```

--------------------------------

### GET Get advanced monitoring statistics

Source: https://easypanel.io/docs/api/endpoints

Returns advanced host monitoring statistics.

```APIDOC
## GET Get advanced monitoring statistics

### Description
Returns advanced host monitoring statistics.

### Method
GET

### Endpoint
Not specified in the source.

```

--------------------------------

### POST /deployAppService

Source: https://easypanel.io/docs/api/services/app/deployAppService

Builds and deploys an application service. Requires authentication and a request body with projectName and serviceName.

```APIDOC
## POST /deployAppService

### Description
Builds and deploys an application service.

### Method
POST

### Endpoint
`/deployAppService`

### Authorization
`bearerAuth` - Bearer token in header.

### Parameters
#### Request Body
- **projectName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **serviceName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **forceRebuild** (boolean) - Optional - Default `false`

### Request Example
```json
{
  "projectName": "string",
  "serviceName": "string"
}
```

### Response
#### Success Response (200)
Response body is `null`.

#### Response Example
```json
null
```
```

--------------------------------

### Get update status GET

Source: https://easypanel.io/docs/api/endpoints

Returns the current version and whether a newer release is available.

```APIDOC
## GET /update-status

### Description
Returns the current version and whether a newer release is available.

### Method
GET

### Endpoint
/update-status

```

--------------------------------

### POST /services/apps/{id}/deploy

Source: https://easypanel.io/docs/api/endpoints

Builds and deploys an existing application service.

```APIDOC
## POST /services/apps/{id}/deploy

### Description
Builds and deploys an application service.

### Method
POST

### Endpoint
/services/apps/{id}/deploy
```

--------------------------------

### POST /createPostgresService

Source: https://easypanel.io/docs/api/services/postgres/createPostgresService

Creates and deploys a PostgreSQL database service. Requires authentication and a request body with project and service names.

```APIDOC
## POST /createPostgresService

### Description
Creates and deploys a PostgreSQL database service.

### Method
POST

### Endpoint
`https://demo.easypanel.io/api/createPostgresService`

### Authorization
`bearerAuth` - Bearer token in header

### Parameters
#### Request Body
- **projectName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **serviceName** (string) - Required - Must match `^[a-z0-9-_]+$`
- **backup** (object) - Optional
- **command** (string) - Optional
- **databaseName** (string) - Optional - Must match `^[a-zA-Z][a-zA-Z0-9_-]{0,62}$`
- **dbGate** (object) - Optional
- **env** (string) - Optional
- **exposedPort** (number) - Optional
- **image** (string) - Optional - Default: `"postgres:17"`
- **password** (string) - Optional - Default: `"cd8uvxna8gngbko4igbl"`
- **pgWeb** (object) - Optional
- **resources** (object) - Optional
- **user** (string) - Optional - Must match `^[a-zA-Z][a-zA-Z0-9_]{0,62}$`

### Request Example
```json
{
  "projectName": "string",
  "serviceName": "string"
}
```

### Response
#### Success Response (200)
Returns `null`.

#### Response Example
```json
null
```

```

--------------------------------

### Get the service domain GET

Source: https://easypanel.io/docs/api/endpoints

Returns the custom and generated base domains used for services.

```APIDOC
## GET Get the service domain

### Description
Returns the custom and generated base domains used for services.

### Method
GET

### Endpoint
Get the service domain
```

--------------------------------

### POST /createLocalProvider

Source: https://easypanel.io/docs/api/storage-providers/local/createLocalProvider

Creates a backup storage provider at a local filesystem path. Requires a bearer token and a JSON body with name and path.

```APIDOC
## POST /createLocalProvider

### Description
Creates a backup storage provider at a local filesystem path.

### Method
POST

### Endpoint
/createLocalProvider

### Authorization
bearerAuth - Bearer <token> (header)

### Parameters
#### Request Body
- **name** (string) - Required - The name of the storage provider.
- **path** (string) - Required - The local filesystem path for the storage provider.

### Request Example
```json
{
  "name": "string",
  "path": "string"
}
```

### Response
#### Success Response (200)
Returns `null`.

#### Response Example
```json
null
```
```

--------------------------------

### Get the panel domain GET

Source: https://easypanel.io/docs/api/endpoints

Returns the custom and generated domains used to access Easypanel.

```APIDOC
## GET Get the panel domain

### Description
Returns the custom and generated domains used to access Easypanel.

### Method
GET

### Endpoint
Get the panel domain
```
Tokens:
Raw