# Easypanel > Deploy applications and open-source services on your own server with a modern, self-hosted platform as a service. ## Primary pages - [Homepage](https://easypanel.io/): Product overview and installation entry point. - [Documentation](https://easypanel.io/docs): Product documentation and API reference. - [Templates](https://easypanel.io/templates): One-click installers for open-source applications. - [Dockerizer](https://easypanel.io/dockerizer): Generate production-ready Dockerfiles and Compose files. - [Pricing](https://easypanel.io/pricing): Easypanel plans and license pricing. - [Changelog](https://easypanel.io/changelog): Product releases, improvements, and fixes. ## Discovery resources - [Full documentation corpus](https://easypanel.io/llms-full.txt): All documentation pages in one text file. - [Sitemap](https://easypanel.io/sitemap.xml): Canonical indexable URLs. ## Documentation index - Product Docs: How to use Easypanel - **Introduction** - [Getting Started](/docs): Install Easypanel on a fresh server. - [Maintenance](/docs/maintenance): Update Easypanel or recover access by resetting the admin password. - Quickstarts - [Quickstarts](/docs/quickstarts): Deploy popular application frameworks and static sites with Easypanel. - [Deploying an Static Website with Easypanel](/docs/quickstarts/static-website): Deploying an Static Website with Easypanel guide - [Hosting a Laravel Application with Easypanel](/docs/quickstarts/laravel): Hosting a Laravel Application with Easypanel guide - [Deploying an Express.js Application with Easypanel](/docs/quickstarts/express): Deploying an Express.js Application with Easypanel guide - [Deploying a Next.js Application with Easypanel](/docs/quickstarts/nextjs): Deploying a Next.js Application with Easypanel - [Deploying a Nest.js Application with Easypanel](/docs/quickstarts/nestjs): Step-by-step guide on deploying a Nest.js application using Easypanel - [Deploying a Nuxt.js Application with Easypanel](/docs/quickstarts/nuxtjs): Deploying a Nuxt.js Application with Easypanel - [Deploying a Django Application with Easypanel](/docs/quickstarts/django): Deploying a Django Application with Easypanel Guide - [Deploying a Flask Application with Easypanel](/docs/quickstarts/flask): Deploying a Flask Application with Easypanel Guide - [Deploying a .NET Application with Easypanel](/docs/quickstarts/dotnet): Deploying a .NET Application with Easypanel Guide - [Deploying a Ruby on Rails Application with Easypanel](/docs/quickstarts/rails): Deploying a Ruby on Rails Application with Easypanel Guide - **Separator** - [Command Line Interface](/docs/cli): Manage Easypanel servers, projects, and services from your terminal. - [Model Context Protocol](/docs/mcp): Connect AI clients to Easypanel through its remote MCP server. - **Separator** - Services - [Services](/docs/services): Configure applications, databases, and Compose services in Easypanel. - [App Service](/docs/services/app): Build, deploy, expose, and operate a single application container. - [MySQL Service](/docs/services/mysql): Run and operate a persistent MySQL database. - [MariaDB Service](/docs/services/mariadb): Run and operate a persistent MariaDB database. - [Postgres Service](/docs/services/postgres): Run and operate a persistent PostgreSQL database. - [Mongo Service](/docs/services/mongo): Run and operate a persistent MongoDB database. - [Redis Service](/docs/services/redis): Run and operate a persistent, password-protected Redis service. - [WordPress Service](/docs/services/wordpress): Deploy and manage WordPress, its runtime, and common site operations. - [Box Service](/docs/services/box): Run applications in a configurable, module-based runtime. - [Compose Service](/docs/services/compose): Deploy and operate multi-container applications with Docker Compose. - **Separator** - Guides - [Guides](/docs/guides): Configure and operate Easypanel beyond the initial installation. - [File Management](/docs/guides/file-management): Learn how to efficiently manage files on Easypanel using FileZilla or FileBrowser - [Custom SSL Certificate Configuration](/docs/guides/custom-ssl): Custom SSL Certificate Configuration guide - [Custom Traefik Configuration](/docs/guides/custom-traefik-config): Custom Traefik Configuration guide - [Running a Cron Job on Easypanel](/docs/guides/cron-job): Running a Cron Job on Easypanel Guide - [Uninstalling Easypanel](/docs/guides/uninstalling-easypanel): Uninstalling Easypanel Guide - [Enabling the Traefik Dashboard](/docs/guides/traefik-dashboard): Enabling the Traefik Dashboard Guide - [Notifications](/docs/guides/notifications): Easypanel notifications - [Setting Up a Wildcard Domain](/docs/guides/wildcard-domain): Learn how to configure a wildcard domain in Easypanel. - [Custom php.ini with Nixpacks](/docs/guides/nixpacks-php-settings): Custom php.ini with Nixpacks - [Pin Easypanel version](/docs/guides/pin-easypanel-version): Pin Easypanel version - [Remote Docker Builder](/docs/guides/remote-docker-builder): Remote Docker Builder - [GPU Support](/docs/guides/gpu-support): Learn how to set up Easypanel with GPU support using the NVIDIA Container Toolkit, allowing you to run GPU-accelerated containers. - [Custom Service Domain](/docs/guides/custom-service-domain): Learn how to configure automatic custom domains for your services in Easypanel. - [Builders](/docs/builders): Choose and configure how Easypanel turns application source into a container image. - Code Sources - [GitHub API](/docs/code-sources/github) - [Git SSH](/docs/code-sources/git-ssh) - Storage Providers - [Storage Providers](/docs/storage-providers): Configure reusable backup destinations for an Easypanel server. - [S3-Compatible Storage](/docs/storage-providers/s3): Configure AWS S3 or an S3-compatible backup destination. - [FTP and SFTP](/docs/storage-providers/ftp-sftp): Configure a password-authenticated FTP or SFTP backup destination. - [Dropbox](/docs/storage-providers/dropbox): Connect Dropbox as an OAuth-based backup destination. - [Google Drive](/docs/storage-providers/google-drive): Connect Google Drive as an OAuth-based backup destination. - [Local Storage](/docs/storage-providers/local): Store backups at a filesystem path on the Easypanel server. - Backups - [Backups](/docs/backups): Protect databases and persistent volume data with external backups. - [Database Backups](/docs/backups/database): Schedule, run, retain, and restore logical database backups. - [Volume Backups](/docs/backups/volumes): Mirror App and Box volume mounts to a storage provider. - API Reference: How to use the API - **Introduction** - [Getting Started](/docs/api-reference): Authenticate and make your first API request. - [Endpoints](/docs/api-reference/endpoints): Explore the Easypanel API endpoints. - **Actions** - [Get an action](/docs/api-reference/actions/getAction): Returns an authorized action record together with its execution log. - [Stop a pending action](/docs/api-reference/actions/killAction): Stops an authorized action when it is still pending. - [List actions](/docs/api-reference/actions/listActions): Returns recent action records visible to the current user. - **Authentication** - [Get the current session](/docs/api-reference/authentication/getSession): Returns the authenticated session, or null when no session is active. - [Get the current user](/docs/api-reference/authentication/getUser): Returns the authenticated user without the stored password. - [Log in](/docs/api-reference/authentication/login): Authenticates a user and returns a session token. - [Log out](/docs/api-reference/authentication/logout): Deletes the current authenticated session. - **Branding** - [Get basic branding settings](/docs/api-reference/branding/getBasicSettings): Returns the server name, color, and basic interface visibility settings. - [Get custom interface code](/docs/api-reference/branding/getCustomCodeSettings): Returns the custom code injected into the Easypanel interface. - [Get error page settings](/docs/api-reference/branding/getErrorPageSettings): Returns the custom styling and visibility settings for error pages. - [Get public interface branding](/docs/api-reference/branding/getInterfaceSettingsPublic): Returns the public light and dark logos used by the interface. - [Get branding link settings](/docs/api-reference/branding/getLinksSettings): Returns which Easypanel navigation and community links are hidden. - [Get logo settings](/docs/api-reference/branding/getLogoSettings): Returns the configured full-size logos and logo marks. - [Get public link visibility](/docs/api-reference/branding/getOtherLinksSettings): Returns whether optional interface links should be hidden. - [Update basic branding settings](/docs/api-reference/branding/setBasicSettings): Replaces the server name, color, and basic interface visibility settings. - [Update custom interface code](/docs/api-reference/branding/setCustomCodeSettings): Replaces the custom code injected into the Easypanel interface. - [Update error page settings](/docs/api-reference/branding/setErrorPageSettings): Replaces the custom styling and visibility settings for error pages. - [Update branding link settings](/docs/api-reference/branding/setLinksSettings): Replaces the visibility settings for navigation and community links. - [Update logo settings](/docs/api-reference/branding/setLogoSettings): Replaces the light and dark logos and logo marks used by Easypanel. - **Certificates** - [List TLS certificates](/docs/api-reference/certificates/listCertificates): Returns the TLS certificates managed by Traefik. - [Remove a TLS certificate](/docs/api-reference/certificates/removeCertificate): Removes the certificate for a domain from Traefik's certificate store. - **Cloudflare Tunnel** - [Create a Cloudflare tunnel rule](/docs/api-reference/cloudflare-tunnel/createTunnelRule): Creates a Cloudflare DNS record and adds it to the tunnel configuration. - [Delete a Cloudflare tunnel rule](/docs/api-reference/cloudflare-tunnel/deleteTunnelRule): Deletes a Cloudflare tunnel rule and its associated DNS record. - [Get Cloudflare tunnel configuration](/docs/api-reference/cloudflare-tunnel/getConfig): Returns the stored Cloudflare tunnel account and connection configuration. - [List Cloudflare tunnel rules](/docs/api-reference/cloudflare-tunnel/getTunnelRules): Lists Cloudflare tunnel rules assigned to a project service. - [List Cloudflare accounts](/docs/api-reference/cloudflare-tunnel/listAccounts): Lists Cloudflare accounts accessible with the provided API token. - [List Cloudflare tunnels](/docs/api-reference/cloudflare-tunnel/listTunnels): Lists tunnels in a Cloudflare account using the provided API token. - [List Cloudflare zones](/docs/api-reference/cloudflare-tunnel/listZones): Lists zones in the configured Cloudflare account. - [Update Cloudflare tunnel configuration](/docs/api-reference/cloudflare-tunnel/setConfig): Updates the stored Cloudflare account, tunnel, and API-token configuration. - [Start the Cloudflare tunnel](/docs/api-reference/cloudflare-tunnel/startTunnel): Starts the configured Cloudflare tunnel service. - [Stop the Cloudflare tunnel](/docs/api-reference/cloudflare-tunnel/stopTunnel): Stops and removes the Cloudflare tunnel service. - [Update a Cloudflare tunnel rule](/docs/api-reference/cloudflare-tunnel/updateTunnelRule): Replaces a Cloudflare tunnel rule and updates its DNS record. - **Cluster** - [Get the worker join command](/docs/api-reference/cluster/addWorkerCommand): Returns the Docker Swarm command used to join a worker to this cluster. - [List cluster nodes](/docs/api-reference/cluster/listNodes): Returns the Docker Swarm nodes in the cluster. - [Remove a cluster node](/docs/api-reference/cluster/removeNode): Removes a non-manager node from the Docker Swarm cluster. - **Database Backups** - [Create a database backup schedule](/docs/api-reference/database-backups/createDatabaseBackup): Creates a scheduled backup configuration for a supported database service. - [Delete a database backup schedule](/docs/api-reference/database-backups/deleteDatabaseBackup): Deletes an authorized database backup configuration and reschedules jobs. - [List service databases](/docs/api-reference/database-backups/getServiceDatabases): Returns the databases available in a supported database service. - [List database backup schedules](/docs/api-reference/database-backups/listDatabaseBackups): Returns backup configurations for a database service. - [Restore a database backup](/docs/api-reference/database-backups/restoreDatabaseBackup): Restores a stored backup into a database, replacing its current contents. - [Run a database backup](/docs/api-reference/database-backups/runDatabaseBackup): Starts an authorized database backup immediately. - [Update a database backup schedule](/docs/api-reference/database-backups/updateDatabaseBackup): Replaces a database backup configuration and reschedules jobs. - **Docker Builders** - [Create a Docker builder](/docs/api-reference/docker-builders/createDockerBuilder): Creates and selects a Docker Buildx builder with configured resource limits. - [List Docker builders](/docs/api-reference/docker-builders/listDockerBuilders): Returns Docker Buildx builders and indicates the currently selected builder. - [Remove a Docker builder](/docs/api-reference/docker-builders/removeDockerBuilder): Deletes a Docker Buildx builder. - [Stop a Docker builder](/docs/api-reference/docker-builders/stopDockerBuilder): Stops a Docker Buildx builder without deleting it. - [Select a Docker builder](/docs/api-reference/docker-builders/useDockerBuilder): Selects a Docker Buildx builder for subsequent builds. - **Domains** - [Create a domain](/docs/api-reference/domains/createDomain): Creates a domain mapping and updates the Traefik configuration. - [Delete a domain](/docs/api-reference/domains/deleteDomain): Deletes an authorized domain mapping and updates the Traefik configuration. - [Get a service primary domain](/docs/api-reference/domains/getPrimaryDomain): Returns the primary domain configured for a service. - [List domains](/docs/api-reference/domains/listDomains): Returns domain mappings visible to the current user, optionally for a service. - [Set a service primary domain](/docs/api-reference/domains/setPrimaryDomain): Sets an authorized domain as its destination service's primary domain. - [Update a domain](/docs/api-reference/domains/updateDomain): Replaces an authorized domain mapping and updates the Traefik configuration. - **Git** - [Generate a service deploy key](/docs/api-reference/git/generateKey): Generates a new SSH deploy key for a Git-backed service. - [Get a service public key](/docs/api-reference/git/getPublicKey): Returns the SSH public key generated for a Git-backed service. - **Git Hub** - [Search GitHub branches](/docs/api-reference/github/searchBranches): Searches branches in a GitHub repository accessible to the panel. - [Search GitHub repositories](/docs/api-reference/github/searchRepos): Returns GitHub repositories accessible to the configured GitHub account. - **Lemon License** - [Activate a license](/docs/api-reference/lemon-license/activateLemonLicense): Activates this Easypanel instance using a Lemon Squeezy license key. - [Activate a license by order](/docs/api-reference/lemon-license/activateByOrder): Activates this Easypanel instance using an order identifier. - [Deactivate the license](/docs/api-reference/lemon-license/deactivateLemonLicense): Deactivates the Lemon Squeezy license for this Easypanel instance. - [Get the license key](/docs/api-reference/lemon-license/getLicenseKey): Returns the stored Lemon Squeezy license key. - [Get license status](/docs/api-reference/lemon-license/getLemonLicensePayload): Returns the validated Lemon Squeezy license status without the license key. - **Logs** - [Get log aggregation settings](/docs/api-reference/logs/getLogsSettings): Returns the current advanced log aggregation configuration. - [Get log aggregation resource usage](/docs/api-reference/logs/getLogsStats): Returns resource and disk usage for the Loki and Promtail services. - [Query Compose service logs](/docs/api-reference/logs/queryComposeServiceLogs): Queries Loki for authorized Docker Compose service log entries. - [Query service logs](/docs/api-reference/logs/queryServiceLogs): Queries Loki for authorized service log entries. - [Update log aggregation settings](/docs/api-reference/logs/updateLogsSettings): Replaces log settings and deploys or removes the log aggregation services. - **Metrics** - [Get all service metrics](/docs/api-reference/metrics/getAllServicesStats): Returns current Prometheus resource metrics for every Docker service. - [Get service metrics](/docs/api-reference/metrics/getMetricsServiceStats): Returns Prometheus resource metrics over time for an authorized service. - [Get metrics settings](/docs/api-reference/metrics/getMetricsSettings): Returns the current advanced metrics configuration. - [Get metrics service resource usage](/docs/api-reference/metrics/getMetricsStats): Returns resource and disk usage for the Prometheus monitoring services. - [Get system metrics](/docs/api-reference/metrics/getMetricsSystemStats): Returns Prometheus host resource metrics over a requested time range. - [Update metrics settings](/docs/api-reference/metrics/updateMetricsSettings): Replaces metrics settings and deploys or removes the monitoring services. - **Middlewares** - [Create a proxy middleware](/docs/api-reference/middlewares/createMiddleware): Creates a Traefik middleware and regenerates the proxy configuration. - [Delete a proxy middleware](/docs/api-reference/middlewares/destroyMiddleware): Deletes a Traefik middleware and regenerates the proxy configuration. - [List proxy middlewares](/docs/api-reference/middlewares/listMiddlewares): Returns all configured Traefik middlewares. - [Update a proxy middleware](/docs/api-reference/middlewares/updateMiddleware): Replaces a Traefik middleware and regenerates the proxy configuration. - **Legacy Monitoring** - [Get advanced monitoring statistics](/docs/api-reference/legacy-monitoring/getAdvancedStats): Returns advanced host monitoring statistics. - [Get Docker task statistics](/docs/api-reference/legacy-monitoring/getDockerTaskStats): Returns desired and running task counts for Docker services. - [Get container monitoring data](/docs/api-reference/legacy-monitoring/getMonitorTableData): Returns live statistics and inferred service names for running containers. - [Get service statistics](/docs/api-reference/legacy-monitoring/getLegacyMonitorServiceStats): Returns live resource statistics for an authorized service. - [Get storage statistics](/docs/api-reference/legacy-monitoring/getStorageStats): Returns host storage usage statistics. - [Get system statistics](/docs/api-reference/legacy-monitoring/getLegacyMonitorSystemStats): Returns current host CPU, memory, disk, network, and uptime statistics. - **Mounts** - [Create a service mount](/docs/api-reference/mounts/createMount): Adds a volume or bind mount to an app or box service. - [Delete a service mount](/docs/api-reference/mounts/deleteMount): Removes a mount from an app or box service by index. - [List service mounts](/docs/api-reference/mounts/listMounts): Returns the configured mounts for an app or box service. - [Update a service mount](/docs/api-reference/mounts/updateMount): Replaces a mount on an app or box service by index. - **Notifications** - [Create a notification channel](/docs/api-reference/notifications/createNotificationChannel): Creates a licensed notification channel and schedules its disk-load checks. - [Delete a notification channel](/docs/api-reference/notifications/destroyNotificationChannel): Deletes a notification channel and reschedules disk-load checks. - [List notification channels](/docs/api-reference/notifications/listNotificationChannels): Returns all notification channels and their delivery configuration. - [Send a test notification](/docs/api-reference/notifications/sendTestNotification): Sends a test message using a supplied notification channel configuration. - [Update a notification channel](/docs/api-reference/notifications/updateNotificationChannel): Replaces a notification channel and reschedules disk-load checks. - **Portal License** - [Activate the portal license](/docs/api-reference/portal-license/activatePortalLicense): Activates this Easypanel instance using its portal license. - [Deactivate the portal license](/docs/api-reference/portal-license/deactivatePortalLicense): Removes the stored portal license from this Easypanel instance. - [Get portal license status](/docs/api-reference/portal-license/getPortalLicensePayload): Returns the current portal license payload. - **Ports** - [Create a service port](/docs/api-reference/ports/createPort): Adds an exposed port to an app or box service. - [Delete all service ports](/docs/api-reference/ports/deleteAllPorts): Removes every exposed port from an app or box service. - [Delete a service port](/docs/api-reference/ports/deletePort): Removes an exposed port from an app or box service by index. - [List service ports](/docs/api-reference/ports/listPorts): Returns the exposed ports configured for an app or box service. - [Update a service port](/docs/api-reference/ports/updatePort): Replaces an exposed port on an app or box service by index. - **Projects** - [Check project creation availability](/docs/api-reference/projects/canCreateProject): Checks whether the current Easypanel license permits another project. - [Create a project](/docs/api-reference/projects/createProject): Creates an empty project and its isolated Docker network. - [Delete a project](/docs/api-reference/projects/destroyProject): Permanently deletes a project, its services, files, stack, and network. - [Get service containers](/docs/api-reference/projects/getDockerContainers): Returns running Docker containers belonging to a service or Compose project. - [Inspect a project](/docs/api-reference/projects/inspectProject): Returns a project with its services and resolved domain configuration. - [List projects](/docs/api-reference/projects/listProjects): Lists the projects accessible to the authenticated user. - [List projects and services](/docs/api-reference/projects/listProjectsAndServices): Lists accessible projects together with their services for resource selection. - [Update project access](/docs/api-reference/projects/updateAccess): Adds or removes a user's access to a project. - [Update project environment](/docs/api-reference/projects/updateProjectEnv): Replaces the environment variables shared by services in a project. - **Server** - [Reboot the server](/docs/api-reference/server/reboot): Immediately reboots the host server running Easypanel. - **Services / App** - [Create app service](/docs/api-reference/services-/-app/createAppService): Creates an application service and deploys it when a source is configured. - [Deploy app service](/docs/api-reference/services-/-app/deployAppService): Builds and deploys an application service. - [Delete app service](/docs/api-reference/services-/-app/destroyAppService): Permanently deletes an application service, its files, domains, backups, and image. - [Disable GitHub auto-deploy](/docs/api-reference/services-/-app/disableAppGithubDeploy): Removes the GitHub deployment webhook for an application service. - [Enable GitHub auto-deploy](/docs/api-reference/services-/-app/enableAppGithubDeploy): Creates a GitHub webhook to deploy an application service automatically. - [Get exposed image ports](/docs/api-reference/services-/-app/getAppExposedPorts): Returns TCP ports exposed by an application service image. - [Inspect app service](/docs/api-reference/services-/-app/inspectAppService): Returns the configuration and deployment details of an application service. - [Refresh app deploy token](/docs/api-reference/services-/-app/refreshAppDeployToken): Rotates the deployment token and updates the GitHub webhook for an application service. - [Restart app service](/docs/api-reference/services-/-app/restartAppService): Restarts an application service without rebuilding its image. - [Start app service](/docs/api-reference/services-/-app/startAppService): Enables and starts an application service. - [Stop app service](/docs/api-reference/services-/-app/stopAppService): Stops and disables an application service. - [Update app basic authentication](/docs/api-reference/services-/-app/updateAppBasicAuth): Replaces basic authentication settings for an application service. - [Update app build settings](/docs/api-reference/services-/-app/updateAppBuild): Replaces build settings for an application service. - [Update app deployment settings](/docs/api-reference/services-/-app/updateAppDeploy): Replaces deployment settings for an application service. - [Update app environment](/docs/api-reference/services-/-app/updateAppEnv): Replaces environment variables for an application service. - [Update app maintenance mode](/docs/api-reference/services-/-app/updateAppMaintenance): Updates maintenance mode settings for an application service. - [Update app redirects](/docs/api-reference/services-/-app/updateAppRedirects): Replaces HTTP redirect rules for an application service. - [Update app resources](/docs/api-reference/services-/-app/updateAppResources): Updates resource limits for an application service. - [Update app scripts](/docs/api-reference/services-/-app/updateAppScripts): Replaces lifecycle scripts for an application service. - [Use Dockerfile source](/docs/api-reference/services-/-app/updateAppSourceDockerfile): Replaces an application service source with an inline Dockerfile. - [Use Git source](/docs/api-reference/services-/-app/updateAppSourceGit): Replaces an application service source with a Git repository and branch. - [Use GitHub source](/docs/api-reference/services-/-app/updateAppSourceGithub): Replaces an application service source with a GitHub repository and branch. - [Use container image source](/docs/api-reference/services-/-app/updateAppSourceImage): Replaces an application service source with a container image. - [Upload app source archive](/docs/api-reference/services-/-app/uploadAppCodeArchive): Extracts a local source archive into an application service. - **Services / Box** - [Create a Box service](/docs/api-reference/services-/-box/createBoxService): Creates a configurable Box application service in a project. - [Destroy a Box service](/docs/api-reference/services-/-box/destroyBoxService): Permanently removes a Box service, its files, image, domains, and backups. - [Clone a Git repository](/docs/api-reference/services-/-box/gitBoxClone): Clones a Git repository into a Box service's code directory. - [Initialize a Box service](/docs/api-reference/services-/-box/initBoxService): Initializes service storage and optionally clones the configured Git repository. - [Inspect a Box service](/docs/api-reference/services-/-box/inspectBoxService): Returns the complete Box service configuration and generated access URLs. - [List Box presets](/docs/api-reference/services-/-box/listBoxPresets): Lists the application presets available for Box services. - [Load a Box preset](/docs/api-reference/services-/-box/loadBoxPreset): Replaces a Box service configuration with a preset, then rebuilds and deploys it. - [Rebuild a Box image](/docs/api-reference/services-/-box/rebuildBoxDockerImage): Rebuilds the Box service Docker image and redeploys the service. - [Refresh a deployment token](/docs/api-reference/services-/-box/refreshBoxDeployToken): Replaces the token used to trigger deployments for a Box service. - [Restart a Box service](/docs/api-reference/services-/-box/restartBoxService): Enables and redeploys a Box service. - [Run a deployment script](/docs/api-reference/services-/-box/runBoxDeployScript): Executes the configured deployment script inside a Box service container. - [Run a script](/docs/api-reference/services-/-box/runBoxScript): Executes supplied script content inside a Box service container. - [Start a Box service](/docs/api-reference/services-/-box/startBoxService): Enables and deploys a stopped Box service. - [Stop a Box service](/docs/api-reference/services-/-box/stopBoxService): Disables and removes the running deployment of a Box service. - [Update advanced settings](/docs/api-reference/services-/-box/updateBoxAdvanced): Replaces the advanced build and startup settings for a Box service. - [Update basic authentication](/docs/api-reference/services-/-box/updateBoxBasicAuth): Replaces the HTTP basic-auth credentials for a Box service. - [Update the deployment script](/docs/api-reference/services-/-box/updateBoxDeployScript): Replaces the deployment script and trigger token for a Box service. - [Update environment variables](/docs/api-reference/services-/-box/updateBoxEnv): Replaces the environment-variable configuration for a Box service. - [Update Git identity](/docs/api-reference/services-/-box/updateBoxGitConfig): Updates the Git author name and email for a Box service. - [Update IDE settings](/docs/api-reference/services-/-box/updateBoxIde): Replaces the browser IDE configuration for a Box service. - [Update enabled modules](/docs/api-reference/services-/-box/updateBoxModules): Replaces the set of runtime and configuration modules enabled for a Box service. - [Update Nginx settings](/docs/api-reference/services-/-box/updateBoxNginx): Replaces the Nginx configuration for a Box service. - [Update Node.js settings](/docs/api-reference/services-/-box/updateBoxNodejs): Replaces the Node.js runtime configuration for a Box service. - [Update PHP settings](/docs/api-reference/services-/-box/updateBoxPhp): Replaces the PHP runtime configuration for a Box service. - [Update managed processes](/docs/api-reference/services-/-box/updateBoxProcesses): Replaces the supervised process configuration and reloads it in the Box container. - [Update Python settings](/docs/api-reference/services-/-box/updateBoxPython): Replaces the Python runtime configuration for a Box service. - [Update redirects](/docs/api-reference/services-/-box/updateBoxRedirects): Replaces the HTTP redirect rules for a Box service. - [Update resource limits](/docs/api-reference/services-/-box/updateBoxResources): Replaces the CPU and memory limits for a Box service. - [Update Ruby settings](/docs/api-reference/services-/-box/updateBoxRuby): Replaces the Ruby runtime configuration for a Box service. - [Update scheduled scripts](/docs/api-reference/services-/-box/updateBoxScripts): Replaces scheduled and webhook-triggered scripts for a Box service. - **Services / Common** - [Get service notes](/docs/api-reference/services-/-common/getServiceNotes): Returns the notes attached to a service. - [Get service error](/docs/api-reference/services-/-common/getServiceError): Returns the latest startup error reported for a service. - [Rename service](/docs/api-reference/services-/-common/renameService): Moves and renames a service, its image, records, files, and domains. - [Update service notes](/docs/api-reference/services-/-common/setServiceNotes): Replaces the notes attached to a service. - **Services / Compose** - [Create Compose service](/docs/api-reference/services-/-compose/createComposeService): Creates and deploys a Docker Compose service. - [Deploy Compose service](/docs/api-reference/services-/-compose/deployComposeService): Builds and deploys a Docker Compose service. - [Delete Compose service](/docs/api-reference/services-/-compose/destroyComposeService): Permanently deletes a Compose service and its files. - [List Compose containers](/docs/api-reference/services-/-compose/getComposeDockerServices): Lists the container service names defined by a Compose service. - [Check Compose issues](/docs/api-reference/services-/-compose/getComposeIssues): Checks a Compose configuration for settings that can conflict with other services. - [Inspect Compose service](/docs/api-reference/services-/-compose/inspectComposeService): Returns the configuration and deployment details of a Compose service. - [Refresh Compose deploy token](/docs/api-reference/services-/-compose/refreshComposeDeployToken): Replaces the deployment token for a Compose service. - [Restart Compose service](/docs/api-reference/services-/-compose/restartComposeService): Restarts all containers in a Compose service. - [Start Compose service](/docs/api-reference/services-/-compose/startComposeService): Enables and starts a Compose service. - [Stop Compose service](/docs/api-reference/services-/-compose/stopComposeService): Stops and disables a Compose service. - [Update Compose basic authentication](/docs/api-reference/services-/-compose/updateComposeBasicAuth): Replaces basic authentication settings for a Compose service. - [Update Compose environment](/docs/api-reference/services-/-compose/updateComposeEnv): Replaces environment variables for a Compose service. - [Update Compose maintenance mode](/docs/api-reference/services-/-compose/updateComposeMaintenance): Updates maintenance mode settings for a Compose service. - [Update Compose redirects](/docs/api-reference/services-/-compose/updateComposeRedirects): Replaces HTTP redirect rules for a Compose service. - [Use Git source for Compose service](/docs/api-reference/services-/-compose/updateComposeSourceGit): Replaces a Compose service source with configuration from a Git repository. - [Update inline Compose source](/docs/api-reference/services-/-compose/updateComposeSourceInline): Replaces the inline Docker Compose configuration for a service. - **Services / Maria D B** - [Create MariaDB service](/docs/api-reference/services-/-mariadb/createMariaDBService): Creates and deploys a MariaDB database service. - [Delete MariaDB service](/docs/api-reference/services-/-mariadb/destroyMariaDBService): Permanently deletes a MariaDB service and its stored data. - [Disable DbGate](/docs/api-reference/services-/-mariadb/disableMariaDBDbGate): Disables the DbGate interface for a MariaDB service. - [Disable phpMyAdmin](/docs/api-reference/services-/-mariadb/disableMariaDBPhpMyAdmin): Disables the phpMyAdmin interface for a MariaDB service. - [Stop MariaDB service](/docs/api-reference/services-/-mariadb/disableMariaDBService): Stops a MariaDB service and disables it. - [Enable DbGate](/docs/api-reference/services-/-mariadb/enableMariaDBDbGate): Enables and deploys the DbGate interface for a MariaDB service. - [Enable phpMyAdmin](/docs/api-reference/services-/-mariadb/enableMariaDBPhpMyAdmin): Enables and deploys the phpMyAdmin interface for a MariaDB service. - [Start MariaDB service](/docs/api-reference/services-/-mariadb/enableMariaDBService): Enables and starts a MariaDB service. - [Expose MariaDB service](/docs/api-reference/services-/-mariadb/exposeMariaDBService): Publishes a MariaDB service on a host port. - [Inspect MariaDB service](/docs/api-reference/services-/-mariadb/inspectMariaDBService): Returns the configuration and status of a MariaDB service. - [Update MariaDB advanced settings](/docs/api-reference/services-/-mariadb/updateMariaDBAdvanced): Updates the image, command, and environment of a MariaDB service and redeploys it. - [Update MariaDB credentials](/docs/api-reference/services-/-mariadb/updateMariaDBCredentials): Changes the database credentials for a MariaDB service and redeploys it. - [Update MariaDB resources](/docs/api-reference/services-/-mariadb/updateMariaDBResources): Updates resource limits for a MariaDB service. - **Services / Mongo D B** - [Create MongoDB service](/docs/api-reference/services-/-mongodb/createMongoDBService): Creates and deploys a MongoDB database service. - [Delete MongoDB service](/docs/api-reference/services-/-mongodb/destroyMongoDBService): Permanently deletes a MongoDB service and its stored data. - [Disable DbGate](/docs/api-reference/services-/-mongodb/disableMongoDBDbGate): Disables the DbGate interface for a MongoDB service. - [Disable mongo-express](/docs/api-reference/services-/-mongodb/disableMongoDBMongoExpress): Disables the mongo-express interface for a MongoDB service. - [Stop MongoDB service](/docs/api-reference/services-/-mongodb/disableMongoDBService): Stops a MongoDB service and disables it. - [Enable DbGate](/docs/api-reference/services-/-mongodb/enableMongoDBDbGate): Enables and deploys the DbGate interface for a MongoDB service. - [Enable mongo-express](/docs/api-reference/services-/-mongodb/enableMongoDBMongoExpress): Enables and deploys the mongo-express interface for a MongoDB service. - [Start MongoDB service](/docs/api-reference/services-/-mongodb/enableMongoDBService): Enables and starts a MongoDB service. - [Expose MongoDB service](/docs/api-reference/services-/-mongodb/exposeMongoDBService): Publishes a MongoDB service on a host port. - [Inspect MongoDB service](/docs/api-reference/services-/-mongodb/inspectMongoDBService): Returns the configuration and status of a MongoDB service. - [Update MongoDB advanced settings](/docs/api-reference/services-/-mongodb/updateMongoDBAdvanced): Updates the image, command, and environment of a MongoDB service and redeploys it. - [Update MongoDB credentials](/docs/api-reference/services-/-mongodb/updateMongoDBCredentials): Changes the password for a MongoDB service and redeploys it. - [Update MongoDB resources](/docs/api-reference/services-/-mongodb/updateMongoDBResources): Updates resource limits for a MongoDB service. - **Services / My S Q L** - [Create MySQL service](/docs/api-reference/services-/-mysql/createMySQLService): Creates and deploys a MySQL database service. - [Delete MySQL service](/docs/api-reference/services-/-mysql/destroyMySQLService): Permanently deletes a MySQL service and its stored data. - [Disable DbGate](/docs/api-reference/services-/-mysql/disableMySQLDbGate): Disables the DbGate interface for a MySQL service. - [Disable phpMyAdmin](/docs/api-reference/services-/-mysql/disableMySQLPhpMyAdmin): Disables the phpMyAdmin interface for a MySQL service. - [Stop MySQL service](/docs/api-reference/services-/-mysql/disableMySQLService): Stops a MySQL service and disables it. - [Enable DbGate](/docs/api-reference/services-/-mysql/enableMySQLDbGate): Enables and deploys the DbGate interface for a MySQL service. - [Enable phpMyAdmin](/docs/api-reference/services-/-mysql/enableMySQLPhpMyAdmin): Enables and deploys the phpMyAdmin interface for a MySQL service. - [Start MySQL service](/docs/api-reference/services-/-mysql/enableMySQLService): Enables and starts a MySQL service. - [Expose MySQL service](/docs/api-reference/services-/-mysql/exposeMySQLService): Publishes a MySQL service on a host port. - [Inspect MySQL service](/docs/api-reference/services-/-mysql/inspectMySQLService): Returns the configuration and status of a MySQL service. - [Update MySQL advanced settings](/docs/api-reference/services-/-mysql/updateMySQLAdvanced): Updates the image, command, and environment of a MySQL service and redeploys it. - [Update MySQL credentials](/docs/api-reference/services-/-mysql/updateMySQLCredentials): Changes the database credentials for a MySQL service and redeploys it. - [Update MySQL resources](/docs/api-reference/services-/-mysql/updateMySQLResources): Updates resource limits for a MySQL service. - **Services / Postgres** - [Create PostgreSQL service](/docs/api-reference/services-/-postgres/createPostgresService): Creates and deploys a PostgreSQL database service. - [Delete PostgreSQL service](/docs/api-reference/services-/-postgres/destroyPostgresService): Permanently deletes a PostgreSQL service and its stored data. - [Disable DbGate](/docs/api-reference/services-/-postgres/disablePostgresDbGate): Disables the DbGate interface for a PostgreSQL service. - [Disable pgweb](/docs/api-reference/services-/-postgres/disablePostgresPgWeb): Disables the pgweb interface for a PostgreSQL service. - [Stop PostgreSQL service](/docs/api-reference/services-/-postgres/disablePostgresService): Stops a PostgreSQL service and disables it. - [Enable DbGate](/docs/api-reference/services-/-postgres/enablePostgresDbGate): Enables and deploys the DbGate interface for a PostgreSQL service. - [Enable pgweb](/docs/api-reference/services-/-postgres/enablePostgresPgWeb): Enables and deploys the pgweb interface for a PostgreSQL service. - [Start PostgreSQL service](/docs/api-reference/services-/-postgres/enablePostgresService): Enables and starts a PostgreSQL service. - [Expose PostgreSQL service](/docs/api-reference/services-/-postgres/exposePostgresService): Publishes a PostgreSQL service on a host port. - [Inspect PostgreSQL service](/docs/api-reference/services-/-postgres/inspectPostgresService): Returns the configuration and status of a PostgreSQL service. - [Update PostgreSQL advanced settings](/docs/api-reference/services-/-postgres/updatePostgresAdvanced): Updates the image, command, and environment of a PostgreSQL service and redeploys it. - [Update PostgreSQL credentials](/docs/api-reference/services-/-postgres/updatePostgresCredentials): Changes the password for a PostgreSQL service and redeploys it. - [Update PostgreSQL resources](/docs/api-reference/services-/-postgres/updatePostgresResources): Updates resource limits for a PostgreSQL service. - **Services / Redis** - [Create Redis service](/docs/api-reference/services-/-redis/createRedisService): Creates and deploys a Redis service. - [Delete Redis service](/docs/api-reference/services-/-redis/destroyRedisService): Permanently deletes a Redis service and its stored data. - [Disable DbGate](/docs/api-reference/services-/-redis/disableRedisDbGate): Disables the DbGate interface for a Redis service. - [Disable Redis Commander](/docs/api-reference/services-/-redis/disableRedisCommander): Disables the Redis Commander interface for a Redis service. - [Stop Redis service](/docs/api-reference/services-/-redis/disableRedisService): Stops a Redis service and disables it. - [Enable DbGate](/docs/api-reference/services-/-redis/enableRedisDbGate): Enables and deploys the DbGate interface for a Redis service. - [Enable Redis Commander](/docs/api-reference/services-/-redis/enableRedisCommander): Enables and deploys the Redis Commander interface for a Redis service. - [Start Redis service](/docs/api-reference/services-/-redis/enableRedisService): Enables and starts a Redis service. - [Expose Redis service](/docs/api-reference/services-/-redis/exposeRedisService): Publishes a Redis service on a host port. - [Inspect Redis service](/docs/api-reference/services-/-redis/inspectRedisService): Returns the configuration and status of a Redis service. - [Update Redis advanced settings](/docs/api-reference/services-/-redis/updateRedisAdvanced): Updates the image, command, and environment of a Redis service and redeploys it. - [Update Redis credentials](/docs/api-reference/services-/-redis/updateRedisCredentials): Changes the password for a Redis service and redeploys it. - [Update Redis resources](/docs/api-reference/services-/-redis/updateRedisResources): Updates resource limits for a Redis service. - **Services / Word Press** - [Activate a WordPress plugin](/docs/api-reference/services-/-wordpress/activateWordPressPlugin): Activates an installed plugin for a WordPress service. - [Activate a WordPress theme](/docs/api-reference/services-/-wordpress/activateWordPressTheme): Activates an installed theme for a WordPress service. - [Create a WordPress option](/docs/api-reference/services-/-wordpress/createWordPressOption): Adds a named option and value to a WordPress site. - [Create a WordPress role](/docs/api-reference/services-/-wordpress/createWordPressRole): Adds a custom role to a WordPress site. - [Create a WordPress service](/docs/api-reference/services-/-wordpress/createWordPressService): Creates and initializes a WordPress application service in a project. - [Create a WordPress user](/docs/api-reference/services-/-wordpress/createWordPressUser): Creates a WordPress user with a password and assigned role. - [Optimize the WordPress database](/docs/api-reference/services-/-wordpress/dbWordPressOptimize): Runs WordPress database table optimization for a service. - [Deactivate a WordPress plugin](/docs/api-reference/services-/-wordpress/deactivateWordPressPlugin): Deactivates an installed plugin for a WordPress service. - [Delete a WordPress option](/docs/api-reference/services-/-wordpress/deleteWordPressOption): Permanently removes a named option from a WordPress site. - [Delete a WordPress role](/docs/api-reference/services-/-wordpress/deleteWordPressRole): Permanently removes a custom role from a WordPress site. - [Delete WordPress transients](/docs/api-reference/services-/-wordpress/deleteWordPressTransient): Clears all transient cache entries from a WordPress site. - [Delete a WordPress user](/docs/api-reference/services-/-wordpress/deleteWordPressUser): Permanently removes a user from a WordPress site. - [Destroy a WordPress service](/docs/api-reference/services-/-wordpress/destroyWordPressService): Permanently removes a WordPress service, its files, image, and domains. - [Flush the WordPress cache](/docs/api-reference/services-/-wordpress/flushWordPressCache): Clears the object cache for a WordPress site. - [List WordPress databases](/docs/api-reference/services-/-wordpress/getWordPressDatabaseServices): Lists MySQL and MariaDB services that can back a WordPress service. - [Get maintenance mode](/docs/api-reference/services-/-wordpress/getWordPressMaintenanceMode): Reports whether maintenance mode is active for a WordPress site. - [List WordPress options](/docs/api-reference/services-/-wordpress/getWordPressOptions): Returns option names and raw values stored by a WordPress site. - [List WordPress plugins](/docs/api-reference/services-/-wordpress/getWordPressPlugins): Lists installed WordPress plugins, versions, status, and available updates. - [Profile WordPress execution](/docs/api-reference/services-/-wordpress/getWordPressProfile): Returns timing and cache metrics for a WordPress execution stage. - [List WordPress roles](/docs/api-reference/services-/-wordpress/getWordPressRoles): Lists the roles defined for a WordPress site. - [List WordPress themes](/docs/api-reference/services-/-wordpress/getWordPressThemes): Lists installed WordPress themes, versions, status, and available updates. - [List WordPress users](/docs/api-reference/services-/-wordpress/getWordPressUsers): Lists WordPress users and their roles and account details. - [Get WordPress configuration](/docs/api-reference/services-/-wordpress/getWordPressWpConfig): Returns the raw wp-config.php file for a WordPress service. - [Clone a Git repository](/docs/api-reference/services-/-wordpress/gitWordPressClone): Clones a Git repository into a WordPress service's code directory. - [Initialize a WordPress service](/docs/api-reference/services-/-wordpress/initWordPressService): Initializes WordPress files, Git content, and the configured database service. - [Inspect a WordPress service](/docs/api-reference/services-/-wordpress/inspectWordPressService): Returns the complete WordPress service configuration and generated access URLs. - [Install a WordPress plugin](/docs/api-reference/services-/-wordpress/installWordPressPlugin): Installs and activates a plugin for a WordPress site. - [Install a WordPress theme](/docs/api-reference/services-/-wordpress/installWordPressTheme): Installs and activates a theme for a WordPress site. - [Regenerate WordPress media](/docs/api-reference/services-/-wordpress/mediaWordPressRegenerate): Regenerates image thumbnails for all media in a WordPress site. - [Rebuild a WordPress image](/docs/api-reference/services-/-wordpress/rebuildWordPressDockerImage): Rebuilds the WordPress service Docker image and redeploys the service. - [Restart a WordPress service](/docs/api-reference/services-/-wordpress/restartWordPressService): Enables and redeploys a WordPress service. - [Run a script](/docs/api-reference/services-/-wordpress/runWordPressScript): Executes supplied script content inside a WordPress service container. - [Search WordPress plugins](/docs/api-reference/services-/-wordpress/searchWordPressPlugin): Searches the WordPress plugin directory from a service container. - [Replace WordPress content](/docs/api-reference/services-/-wordpress/searchWordPressReplace): Searches for text across the WordPress database and replaces every match. - [Preview WordPress replacement](/docs/api-reference/services-/-wordpress/searchWordPressReplaceDryRun): Previews database changes from a WordPress search-and-replace operation. - [Search WordPress themes](/docs/api-reference/services-/-wordpress/searchWordPressTheme): Searches the WordPress theme directory from a service container. - [Start a WordPress service](/docs/api-reference/services-/-wordpress/startWordPressService): Enables and deploys a stopped WordPress service. - [Stop a WordPress service](/docs/api-reference/services-/-wordpress/stopWordPressService): Disables and removes the running deployment of a WordPress service. - [Update basic authentication](/docs/api-reference/services-/-wordpress/updateWordPressBasicAuth): Replaces the HTTP basic-auth credentials for a WordPress service. - [Update environment variables](/docs/api-reference/services-/-wordpress/updateWordPressEnv): Replaces the environment-variable configuration for a WordPress service. - [Update Git identity](/docs/api-reference/services-/-wordpress/updateWordPressGitConfig): Updates the Git author name and email for a WordPress service. - [Update IDE settings](/docs/api-reference/services-/-wordpress/updateWordPressIde): Replaces the browser IDE configuration for a WordPress service. - [Update maintenance mode](/docs/api-reference/services-/-wordpress/updateWordPressMaintenanceMode): Activates or deactivates maintenance mode for a WordPress site. - [Update Nginx settings](/docs/api-reference/services-/-wordpress/updateWordPressNginx): Replaces the Nginx configuration for a WordPress service. - [Update a WordPress option](/docs/api-reference/services-/-wordpress/updateWordPressOption): Replaces the value of a named option in a WordPress site. - [Update PHP settings](/docs/api-reference/services-/-wordpress/updateWordPressPhp): Replaces the PHP runtime configuration for a WordPress service. - [Update redirects](/docs/api-reference/services-/-wordpress/updateWordPressRedirects): Replaces the HTTP redirect rules for a WordPress service. - [Update resource limits](/docs/api-reference/services-/-wordpress/updateWordPressResources): Replaces the CPU and memory limits for a WordPress service. - [Update scheduled scripts](/docs/api-reference/services-/-wordpress/updateWordPressScripts): Replaces scheduled and webhook-triggered scripts for a WordPress service. - [Update a WordPress user](/docs/api-reference/services-/-wordpress/updateWordPressUser): Replaces profile, role, and optional password details for a WordPress user. - [Update WordPress configuration](/docs/api-reference/services-/-wordpress/updateWordPressWpConfig): Overwrites the wp-config.php file for a WordPress service. - [Update WordPress core](/docs/api-reference/services-/-wordpress/updateWordPressWpCore): Updates WordPress core files and applies any required database upgrade. - **Settings** - [Change account credentials](/docs/api-reference/settings/changeCredentials): Changes the authenticated user's email address and password. - [Check for Docker updates](/docs/api-reference/settings/checkDockerUpdate): Checks whether a newer Docker engine version is available. - [Check for Easypanel updates](/docs/api-reference/settings/checkForUpdates): Checks whether a newer Easypanel version is available. - [Clean Docker build cache](/docs/api-reference/settings/cleanupDockerBuilder): Removes unused Docker build cache from the server. - [Clean Docker images](/docs/api-reference/settings/cleanupDockerImages): Removes unused Docker images from the server. - [Get daily Docker cleanup setting](/docs/api-reference/settings/getDailyDockerCleanup): Returns whether automatic daily Docker cleanup is enabled. - [Get demo mode](/docs/api-reference/settings/getDemoMode): Returns whether this Easypanel installation is running in demo mode. - [Get Docker version](/docs/api-reference/settings/getDockerVersion): Returns the Docker engine version installed on the server. - [Get the GitHub token](/docs/api-reference/settings/getGithubToken): Returns the GitHub access token stored by Easypanel. - [Get Google Analytics measurement ID](/docs/api-reference/settings/getGoogleAnalyticsMeasurementId): Returns the public Google Analytics measurement identifier. - [Get the Let's Encrypt email](/docs/api-reference/settings/getLetsEncryptEmail): Returns the email address used for Let's Encrypt certificates. - [Get the panel domain](/docs/api-reference/settings/getPanelDomain): Returns the custom and generated domains used to access Easypanel. - [Get the server IP address](/docs/api-reference/settings/getServerIp): Returns the public IP address recorded for the Easypanel server. - [Get the service domain](/docs/api-reference/settings/getServiceDomain): Returns the custom and generated base domains used for services. - [Get telemetry setting](/docs/api-reference/settings/getTelemetryDisabled): Returns whether anonymous Easypanel telemetry is disabled. - [Refresh the server IP address](/docs/api-reference/settings/refreshServerIp): Refreshes the server IP, generated domain, certificates, and service domains. - [Restart Easypanel](/docs/api-reference/settings/restartEasypanel): Redeploys the Easypanel service on the current server. - [Update daily Docker cleanup](/docs/api-reference/settings/setDailyDockerCleanup): Enables or disables the scheduled daily Docker cleanup job. - [Update the GitHub token](/docs/api-reference/settings/setGithubToken): Validates and replaces the GitHub access token stored by Easypanel. - [Update Google Analytics](/docs/api-reference/settings/setGoogleAnalyticsMeasurementId): Replaces the Google Analytics measurement identifier used by Easypanel. - [Update the Let's Encrypt email](/docs/api-reference/settings/setLetsEncryptEmail): Replaces the email address used when requesting Let's Encrypt certificates. - [Update the panel domain](/docs/api-reference/settings/setPanelDomain): Replaces the custom panel domain and IP-access setting. - [Update the service domain](/docs/api-reference/settings/setServiceDomain): Replaces the custom base domain used for exposed services. - [Update telemetry setting](/docs/api-reference/settings/setTelemetryDisabled): Enables or disables anonymous Easypanel telemetry. - [Prune Docker system data](/docs/api-reference/settings/systemPrune): Prunes unused Docker data from the Easypanel server. - **Setup** - [Get setup status](/docs/api-reference/setup/getSetupStatus): Reports whether initial Easypanel setup has been completed. - [Set up Easypanel](/docs/api-reference/setup/setup): Creates the initial administrator and configures the Easypanel instance. - **Storage Providers / Common** - [List storage providers](/docs/api-reference/storage-providers-/-common/listStorageProviders): Returns all configured storage providers, including their connection settings. - [List connected storage provider options](/docs/api-reference/storage-providers-/-common/listStorageProviderOptions): Returns names and identifiers for connected storage providers. - **Storage Providers / Dropbox** - [Create a Dropbox storage provider](/docs/api-reference/storage-providers-/-dropbox/createDropboxProvider): Creates a Dropbox storage provider ready for OAuth connection. - [Delete a Dropbox storage provider](/docs/api-reference/storage-providers-/-dropbox/deleteDropboxProvider): Disconnects and deletes a Dropbox storage provider. - [Disconnect a Dropbox storage provider](/docs/api-reference/storage-providers-/-dropbox/disconnectDropboxProvider): Revokes the Dropbox connection and removes its stored token. - [Update a Dropbox storage provider](/docs/api-reference/storage-providers-/-dropbox/updateDropboxProvider): Updates the name of a Dropbox storage provider. - **Storage Providers / F T P** - [Create an FTP storage provider](/docs/api-reference/storage-providers-/-ftp/createFTProvider): Validates and stores an FTP backup destination. - [Delete an FTP storage provider](/docs/api-reference/storage-providers-/-ftp/deleteFTProvider): Deletes an FTP backup destination configuration. - [Update an FTP storage provider](/docs/api-reference/storage-providers-/-ftp/updateFTProvider): Validates and replaces an FTP backup destination. - **Storage Providers / Google** - [Create a Google Drive storage provider](/docs/api-reference/storage-providers-/-google/createGoogleProvider): Creates a Google Drive storage provider ready for OAuth connection. - [Delete a Google Drive storage provider](/docs/api-reference/storage-providers-/-google/deleteGoogleProvider): Disconnects and deletes a Google Drive storage provider. - [Disconnect a Google Drive storage provider](/docs/api-reference/storage-providers-/-google/disconnectGoogleProvider): Revokes the Google Drive connection and removes its stored token. - [Update a Google Drive storage provider](/docs/api-reference/storage-providers-/-google/updateGoogleProvider): Updates the name of a Google Drive storage provider. - **Storage Providers / Local** - [Create a local storage provider](/docs/api-reference/storage-providers-/-local/createLocalProvider): Creates a backup storage provider at a local filesystem path. - [Delete a local storage provider](/docs/api-reference/storage-providers-/-local/deleteLocalProvider): Deletes a local backup storage provider configuration. - [Update a local storage provider](/docs/api-reference/storage-providers-/-local/updateLocalProvider): Replaces the name and filesystem path of a local storage provider. - **Storage Providers / S3** - [Create an S3 storage provider](/docs/api-reference/storage-providers-/-s3/createS3Provider): Validates and stores an S3-compatible backup destination. - [Delete an S3 storage provider](/docs/api-reference/storage-providers-/-s3/deleteS3Provider): Deletes an S3-compatible backup destination configuration. - [Update an S3 storage provider](/docs/api-reference/storage-providers-/-s3/updateS3Provider): Validates and replaces an S3-compatible backup destination. - **Storage Providers / S F T P** - [Create an SFTP storage provider](/docs/api-reference/storage-providers-/-sftp/createSFTProvider): Validates and stores an SFTP backup destination. - [Delete an SFTP storage provider](/docs/api-reference/storage-providers-/-sftp/deleteSFTProvider): Deletes an SFTP backup destination configuration. - [Update an SFTP storage provider](/docs/api-reference/storage-providers-/-sftp/updateSFTProvider): Validates and replaces an SFTP backup destination. - **Subscription** - [Subscribe to action invalidations](/docs/api-reference/subscription/onInvalidateActions): Streams notifications when the action log should be refreshed. - **Templates** - [Create services from a template](/docs/api-reference/templates/createFromSchema): Creates all services described by a template in an existing project. - **Traefik** - [Get custom Traefik configuration](/docs/api-reference/traefik/getCustomConfig): Returns the raw custom Traefik YAML configuration. - [Get Traefik dashboard access](/docs/api-reference/traefik/getDashboard): Returns the Traefik dashboard domain and creates its access token if needed. - [Get the Traefik environment](/docs/api-reference/traefik/getEnv): Returns the raw Traefik environment file. - [Restart Traefik](/docs/api-reference/traefik/restart): Rotates the dashboard token, regenerates configuration, and redeploys Traefik. - [Set custom Traefik configuration](/docs/api-reference/traefik/setCustomConfig): Overwrites the raw custom Traefik YAML configuration. - [Set the Traefik environment](/docs/api-reference/traefik/setEnv): Overwrites the raw Traefik environment file. - **Two Factor Authentication** - [Configure two-factor authentication](/docs/api-reference/two-factor-authentication/configure): Creates and returns a new two-factor authentication secret and QR code. - [Disable two-factor authentication](/docs/api-reference/two-factor-authentication/disable): Disables two-factor authentication for the current user. - [Enable two-factor authentication](/docs/api-reference/two-factor-authentication/enable): Verifies a one-time code and enables two-factor authentication. - **Update** - [Get update status](/docs/api-reference/update/getUpdateStatus): Returns the current version and whether a newer release is available. - [Update Easypanel](/docs/api-reference/update/update): Pulls the latest configured Easypanel image and redeploys Easypanel. - **Users** - [Create a user](/docs/api-reference/users/createUser): Creates a licensed Easypanel user with an administrator role and password. - [Delete a user](/docs/api-reference/users/destroyUser): Deletes another Easypanel user. - [Generate an API token](/docs/api-reference/users/generateApiToken): Generates and stores a new API token for a user. - [List users](/docs/api-reference/users/listUsers): Returns Easypanel users without their passwords. - [Revoke an API token](/docs/api-reference/users/revokeApiToken): Revokes the stored API token for a user. - [Update a user](/docs/api-reference/users/updateUser): Updates another user's administrator role and optionally replaces the password. - **Volume Backups** - [Create a volume backup schedule](/docs/api-reference/volume-backups/createVolumeBackup): Creates a scheduled backup configuration for a service volume. - [Delete a volume backup schedule](/docs/api-reference/volume-backups/destroyVolumeBackup): Deletes an authorized volume backup configuration and reschedules jobs. - [List volume backup schedules](/docs/api-reference/volume-backups/listVolumeBackups): Returns backup configurations for a service's volumes. - [List volume mounts](/docs/api-reference/volume-backups/listVolumeMounts): Returns the Docker volume mounts available for backup on a service. - [Run a volume backup](/docs/api-reference/volume-backups/runVolumeBackup): Starts an authorized service volume backup immediately. - [Update a volume backup schedule](/docs/api-reference/volume-backups/updateVolumeBackup): Replaces a volume backup configuration and reschedules jobs.