Endpoints

Returns an authorized action record together with its execution log.

Stops an authorized action when it is still pending.

Returns recent action records visible to the current user.

Returns the authenticated session, or null when no session is active.

Returns the authenticated user without the stored password.

Authenticates a user and returns a session token.

Deletes the current authenticated session.

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

Returns the custom code injected into the Easypanel interface.

Returns the custom styling and visibility settings for error pages.

Returns the public light and dark logos used by the interface.

Returns which Easypanel navigation and community links are hidden.

Returns the configured full-size logos and logo marks.

Returns whether optional interface links should be hidden.

Replaces the server name, color, and basic interface visibility settings.

Replaces the custom code injected into the Easypanel interface.

Replaces the custom styling and visibility settings for error pages.

Replaces the visibility settings for navigation and community links.

Replaces the light and dark logos and logo marks used by Easypanel.

Returns the TLS certificates managed by Traefik.

Removes the certificate for a domain from Traefik's certificate store.

Creates a Cloudflare DNS record and adds it to the tunnel configuration.

Deletes a Cloudflare tunnel rule and its associated DNS record.

Returns the stored Cloudflare tunnel account and connection configuration.

Lists Cloudflare tunnel rules assigned to a project service.

Lists Cloudflare accounts accessible with the provided API token.

Lists tunnels in a Cloudflare account using the provided API token.

Lists zones in the configured Cloudflare account.

Updates the stored Cloudflare account, tunnel, and API-token configuration.

Starts the configured Cloudflare tunnel service.

Stops and removes the Cloudflare tunnel service.

Replaces a Cloudflare tunnel rule and updates its DNS record.

Returns the Docker Swarm command used to join a worker to this cluster.

Returns the Docker Swarm nodes in the cluster.

Removes a non-manager node from the Docker Swarm cluster.

Creates a scheduled backup configuration for a supported database service.

Deletes an authorized database backup configuration and reschedules jobs.

Returns the databases available in a supported database service.

Returns backup configurations for a database service.

Restores a stored backup into a database, replacing its current contents.

Starts an authorized database backup immediately.

Replaces a database backup configuration and reschedules jobs.

Creates and selects a Docker Buildx builder with configured resource limits.

Returns Docker Buildx builders and indicates the currently selected builder.

Deletes a Docker Buildx builder.

Stops a Docker Buildx builder without deleting it.

Selects a Docker Buildx builder for subsequent builds.

Creates a domain mapping and updates the Traefik configuration.

Deletes an authorized domain mapping and updates the Traefik configuration.

Returns the primary domain configured for a service.

Returns domain mappings visible to the current user, optionally for a service.

Sets an authorized domain as its destination service's primary domain.

Replaces an authorized domain mapping and updates the Traefik configuration.

Generates a new SSH deploy key for a Git-backed service.

Returns the SSH public key generated for a Git-backed service.

Searches branches in a GitHub repository accessible to the panel.

Returns GitHub repositories accessible to the configured GitHub account.

Activates this Easypanel instance using a Lemon Squeezy license key.

Activates this Easypanel instance using an order identifier.

Deactivates the Lemon Squeezy license for this Easypanel instance.

Returns the stored Lemon Squeezy license key.

Returns the validated Lemon Squeezy license status without the license key.

Returns the current advanced log aggregation configuration.

Returns resource and disk usage for the Loki and Promtail services.

Queries Loki for authorized Docker Compose service log entries.

Queries Loki for authorized service log entries.

Replaces log settings and deploys or removes the log aggregation services.

Returns current Prometheus resource metrics for every Docker service.

Returns Prometheus resource metrics over time for an authorized service.

Returns the current advanced metrics configuration.

Returns resource and disk usage for the Prometheus monitoring services.

Returns Prometheus host resource metrics over a requested time range.

Replaces metrics settings and deploys or removes the monitoring services.

Creates a Traefik middleware and regenerates the proxy configuration.

Deletes a Traefik middleware and regenerates the proxy configuration.

Returns all configured Traefik middlewares.

Replaces a Traefik middleware and regenerates the proxy configuration.

Returns advanced host monitoring statistics.

Returns desired and running task counts for Docker services.

Returns live statistics and inferred service names for running containers.

Returns live resource statistics for an authorized service.

Returns host storage usage statistics.

Returns current host CPU, memory, disk, network, and uptime statistics.

Adds a volume or bind mount to an app or box service.

Removes a mount from an app or box service by index.

Returns the configured mounts for an app or box service.

Replaces a mount on an app or box service by index.

Creates a licensed notification channel and schedules its disk-load checks.

Deletes a notification channel and reschedules disk-load checks.

Returns all notification channels and their delivery configuration.

Sends a test message using a supplied notification channel configuration.

Replaces a notification channel and reschedules disk-load checks.

Activates this Easypanel instance using its portal license.

Removes the stored portal license from this Easypanel instance.

Returns the current portal license payload.

Adds an exposed port to an app or box service.

Removes every exposed port from an app or box service.

Removes an exposed port from an app or box service by index.

Returns the exposed ports configured for an app or box service.

Replaces an exposed port on an app or box service by index.

Checks whether the current Easypanel license permits another project.

Creates an empty project and its isolated Docker network.

Permanently deletes a project, its services, files, stack, and network.

Returns running Docker containers belonging to a service or Compose project.

Returns a project with its services and resolved domain configuration.

Lists the projects accessible to the authenticated user.

Lists accessible projects together with their services for resource selection.

Adds or removes a user's access to a project.

Replaces the environment variables shared by services in a project.

Immediately reboots the host server running Easypanel.

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

Builds and deploys an application service.

Permanently deletes an application service, its files, domains, backups, and image.

Removes the GitHub deployment webhook for an application service.

Creates a GitHub webhook to deploy an application service automatically.

Returns TCP ports exposed by an application service image.

Returns the configuration and deployment details of an application service.

Rotates the deployment token and updates the GitHub webhook for an application service.

Restarts an application service without rebuilding its image.

Enables and starts an application service.

Stops and disables an application service.

Replaces basic authentication settings for an application service.

Replaces build settings for an application service.

Replaces deployment settings for an application service.

Replaces environment variables for an application service.

Updates maintenance mode settings for an application service.

Replaces HTTP redirect rules for an application service.

Updates resource limits for an application service.

Replaces lifecycle scripts for an application service.

Replaces an application service source with an inline Dockerfile.

Replaces an application service source with a Git repository and branch.

Replaces an application service source with a GitHub repository and branch.

Replaces an application service source with a container image.

Extracts a local source archive into an application service.

Creates a configurable Box application service in a project.

Permanently removes a Box service, its files, image, domains, and backups.

Clones a Git repository into a Box service's code directory.

Initializes service storage and optionally clones the configured Git repository.

Returns the complete Box service configuration and generated access URLs.

Lists the application presets available for Box services.

Replaces a Box service configuration with a preset, then rebuilds and deploys it.

Rebuilds the Box service Docker image and redeploys the service.

Replaces the token used to trigger deployments for a Box service.

Enables and redeploys a Box service.

Executes the configured deployment script inside a Box service container.

Executes supplied script content inside a Box service container.

Enables and deploys a stopped Box service.

Disables and removes the running deployment of a Box service.

Replaces the advanced build and startup settings for a Box service.

Replaces the HTTP basic-auth credentials for a Box service.

Replaces the deployment script and trigger token for a Box service.

Replaces the environment-variable configuration for a Box service.

Updates the Git author name and email for a Box service.

Replaces the browser IDE configuration for a Box service.

Replaces the set of runtime and configuration modules enabled for a Box service.

Replaces the Nginx configuration for a Box service.

Replaces the Node.js runtime configuration for a Box service.

Replaces the PHP runtime configuration for a Box service.

Replaces the supervised process configuration and reloads it in the Box container.

Replaces the Python runtime configuration for a Box service.

Replaces the HTTP redirect rules for a Box service.

Replaces the CPU and memory limits for a Box service.

Replaces the Ruby runtime configuration for a Box service.

Replaces scheduled and webhook-triggered scripts for a Box service.

Returns the notes attached to a service.

Returns the latest startup error reported for a service.

Moves and renames a service, its image, records, files, and domains.

Replaces the notes attached to a service.

Creates and deploys a Docker Compose service.

Builds and deploys a Docker Compose service.

Permanently deletes a Compose service and its files.

Lists the container service names defined by a Compose service.

Checks a Compose configuration for settings that can conflict with other services.

Returns the configuration and deployment details of a Compose service.

Replaces the deployment token for a Compose service.

Restarts all containers in a Compose service.

Enables and starts a Compose service.

Stops and disables a Compose service.

Replaces basic authentication settings for a Compose service.

Replaces environment variables for a Compose service.

Updates maintenance mode settings for a Compose service.

Replaces HTTP redirect rules for a Compose service.

Replaces a Compose service source with configuration from a Git repository.

Replaces the inline Docker Compose configuration for a service.

Creates and deploys a MariaDB database service.

Permanently deletes a MariaDB service and its stored data.

Disables the DbGate interface for a MariaDB service.

Disables the phpMyAdmin interface for a MariaDB service.

Stops a MariaDB service and disables it.

Enables and deploys the DbGate interface for a MariaDB service.

Enables and deploys the phpMyAdmin interface for a MariaDB service.

Enables and starts a MariaDB service.

Publishes a MariaDB service on a host port.

Returns the configuration and status of a MariaDB service.

Updates the image, command, and environment of a MariaDB service and redeploys it.

Changes the database credentials for a MariaDB service and redeploys it.

Updates resource limits for a MariaDB service.

Creates and deploys a MongoDB database service.

Permanently deletes a MongoDB service and its stored data.

Disables the DbGate interface for a MongoDB service.

Disables the mongo-express interface for a MongoDB service.

Stops a MongoDB service and disables it.

Enables and deploys the DbGate interface for a MongoDB service.

Enables and deploys the mongo-express interface for a MongoDB service.

Enables and starts a MongoDB service.

Publishes a MongoDB service on a host port.

Returns the configuration and status of a MongoDB service.

Updates the image, command, and environment of a MongoDB service and redeploys it.

Changes the password for a MongoDB service and redeploys it.

Updates resource limits for a MongoDB service.

Creates and deploys a MySQL database service.

Permanently deletes a MySQL service and its stored data.

Disables the DbGate interface for a MySQL service.

Disables the phpMyAdmin interface for a MySQL service.

Stops a MySQL service and disables it.

Enables and deploys the DbGate interface for a MySQL service.

Enables and deploys the phpMyAdmin interface for a MySQL service.

Enables and starts a MySQL service.

Publishes a MySQL service on a host port.

Returns the configuration and status of a MySQL service.

Updates the image, command, and environment of a MySQL service and redeploys it.

Changes the database credentials for a MySQL service and redeploys it.

Updates resource limits for a MySQL service.

Creates and deploys a PostgreSQL database service.

Permanently deletes a PostgreSQL service and its stored data.

Disables the DbGate interface for a PostgreSQL service.

Disables the pgweb interface for a PostgreSQL service.

Stops a PostgreSQL service and disables it.

Enables and deploys the DbGate interface for a PostgreSQL service.

Enables and deploys the pgweb interface for a PostgreSQL service.

Enables and starts a PostgreSQL service.

Publishes a PostgreSQL service on a host port.

Returns the configuration and status of a PostgreSQL service.

Updates the image, command, and environment of a PostgreSQL service and redeploys it.

Changes the password for a PostgreSQL service and redeploys it.

Updates resource limits for a PostgreSQL service.

Creates and deploys a Redis service.

Permanently deletes a Redis service and its stored data.

Disables the DbGate interface for a Redis service.

Disables the Redis Commander interface for a Redis service.

Stops a Redis service and disables it.

Enables and deploys the DbGate interface for a Redis service.

Enables and deploys the Redis Commander interface for a Redis service.

Enables and starts a Redis service.

Publishes a Redis service on a host port.

Returns the configuration and status of a Redis service.

Updates the image, command, and environment of a Redis service and redeploys it.

Changes the password for a Redis service and redeploys it.

Updates resource limits for a Redis service.

Activates an installed plugin for a WordPress service.

Activates an installed theme for a WordPress service.

Adds a named option and value to a WordPress site.

Adds a custom role to a WordPress site.

Creates and initializes a WordPress application service in a project.

Creates a WordPress user with a password and assigned role.

Runs WordPress database table optimization for a service.

Deactivates an installed plugin for a WordPress service.

Permanently removes a named option from a WordPress site.

Permanently removes a custom role from a WordPress site.

Clears all transient cache entries from a WordPress site.

Permanently removes a user from a WordPress site.

Permanently removes a WordPress service, its files, image, and domains.

Clears the object cache for a WordPress site.

Lists MySQL and MariaDB services that can back a WordPress service.

Reports whether maintenance mode is active for a WordPress site.

Returns option names and raw values stored by a WordPress site.

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

Returns timing and cache metrics for a WordPress execution stage.

Lists the roles defined for a WordPress site.

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

Lists WordPress users and their roles and account details.

Returns the raw wp-config.php file for a WordPress service.

Clones a Git repository into a WordPress service's code directory.

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

Returns the complete WordPress service configuration and generated access URLs.

Installs and activates a plugin for a WordPress site.

Installs and activates a theme for a WordPress site.

Regenerates image thumbnails for all media in a WordPress site.

Rebuilds the WordPress service Docker image and redeploys the service.

Enables and redeploys a WordPress service.

Executes supplied script content inside a WordPress service container.

Searches the WordPress plugin directory from a service container.

Searches for text across the WordPress database and replaces every match.

Previews database changes from a WordPress search-and-replace operation.

Searches the WordPress theme directory from a service container.

Enables and deploys a stopped WordPress service.

Disables and removes the running deployment of a WordPress service.

Replaces the HTTP basic-auth credentials for a WordPress service.

Replaces the environment-variable configuration for a WordPress service.

Updates the Git author name and email for a WordPress service.

Replaces the browser IDE configuration for a WordPress service.

Activates or deactivates maintenance mode for a WordPress site.

Replaces the Nginx configuration for a WordPress service.

Replaces the value of a named option in a WordPress site.

Replaces the PHP runtime configuration for a WordPress service.

Replaces the HTTP redirect rules for a WordPress service.

Replaces the CPU and memory limits for a WordPress service.

Replaces scheduled and webhook-triggered scripts for a WordPress service.

Replaces profile, role, and optional password details for a WordPress user.

Overwrites the wp-config.php file for a WordPress service.

Updates WordPress core files and applies any required database upgrade.

Changes the authenticated user's email address and password.

Checks whether a newer Docker engine version is available.

Checks whether a newer Easypanel version is available.

Removes unused Docker build cache from the server.

Removes unused Docker images from the server.

Returns whether automatic daily Docker cleanup is enabled.

Returns whether this Easypanel installation is running in demo mode.

Returns the Docker engine version installed on the server.

Returns the GitHub access token stored by Easypanel.

Returns the public Google Analytics measurement identifier.

Returns the email address used for Let's Encrypt certificates.

Returns the custom and generated domains used to access Easypanel.

Returns the public IP address recorded for the Easypanel server.

Returns the custom and generated base domains used for services.

Returns whether anonymous Easypanel telemetry is disabled.

Refreshes the server IP, generated domain, certificates, and service domains.

Redeploys the Easypanel service on the current server.

Enables or disables the scheduled daily Docker cleanup job.

Validates and replaces the GitHub access token stored by Easypanel.

Replaces the Google Analytics measurement identifier used by Easypanel.

Replaces the email address used when requesting Let's Encrypt certificates.

Replaces the custom panel domain and IP-access setting.

Replaces the custom base domain used for exposed services.

Enables or disables anonymous Easypanel telemetry.

Prunes unused Docker data from the Easypanel server.

Reports whether initial Easypanel setup has been completed.

Creates the initial administrator and configures the Easypanel instance.

Returns all configured storage providers, including their connection settings.

Returns names and identifiers for connected storage providers.

Creates a Dropbox storage provider ready for OAuth connection.

Disconnects and deletes a Dropbox storage provider.

Revokes the Dropbox connection and removes its stored token.

Updates the name of a Dropbox storage provider.

Validates and stores an FTP backup destination.

Deletes an FTP backup destination configuration.

Validates and replaces an FTP backup destination.

Creates a Google Drive storage provider ready for OAuth connection.

Disconnects and deletes a Google Drive storage provider.

Revokes the Google Drive connection and removes its stored token.

Updates the name of a Google Drive storage provider.

Creates a backup storage provider at a local filesystem path.

Deletes a local backup storage provider configuration.

Replaces the name and filesystem path of a local storage provider.

Validates and stores an S3-compatible backup destination.

Deletes an S3-compatible backup destination configuration.

Validates and replaces an S3-compatible backup destination.

Validates and stores an SFTP backup destination.

Deletes an SFTP backup destination configuration.

Validates and replaces an SFTP backup destination.

Streams notifications when the action log should be refreshed.

Creates all services described by a template in an existing project.

Returns the raw custom Traefik YAML configuration.

Returns the Traefik dashboard domain and creates its access token if needed.

Returns the raw Traefik environment file.

Rotates the dashboard token, regenerates configuration, and redeploys Traefik.

Overwrites the raw custom Traefik YAML configuration.

Overwrites the raw Traefik environment file.

Creates and returns a new two-factor authentication secret and QR code.

Disables two-factor authentication for the current user.

Verifies a one-time code and enables two-factor authentication.

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

Pulls the latest configured Easypanel image and redeploys Easypanel.

Creates a licensed Easypanel user with an administrator role and password.

Deletes another Easypanel user.

Generates and stores a new API token for a user.

Returns Easypanel users without their passwords.

Revokes the stored API token for a user.

Updates another user's administrator role and optionally replaces the password.

Creates a scheduled backup configuration for a service volume.

Deletes an authorized volume backup configuration and reschedules jobs.

Returns backup configurations for a service's volumes.

Returns the Docker volume mounts available for backup on a service.

Starts an authorized service volume backup immediately.

Replaces a volume backup configuration and reschedules jobs.