### GET /utils/installable-apps Source: https://apidocs.enhance.com/ Retrieves a list of all available installable applications. ```APIDOC ## GET /utils/installable-apps ### Description Get all installable applications ### Method GET ### Endpoint /utils/installable-apps ``` -------------------------------- ### Get slave installation command Source: https://apidocs.enhance.com/ Retrieves the command needed to install a slave server. ```APIDOC ## GET /servers/install-cmd ### Description Get slave installation command. ### Method GET ### Endpoint /servers/install-cmd ``` -------------------------------- ### GET /orgs/{org_id}/subscriptions/{subscription_id}/installable-apps Source: https://apidocs.enhance.com/ Retrieves a list of installable website applications for a given subscription. ```APIDOC ## GET /orgs/{org_id}/subscriptions/{subscription_id}/installable-apps ### Description Get installable website applications ### Method GET ### Endpoint /orgs/{org_id}/subscriptions/{subscription_id}/installable-apps ``` -------------------------------- ### GET /websites/{website_id}/apps/node/versions Source: https://apidocs.enhance.com/ Lists the installed Node.js versions for a website using nvm. ```APIDOC ## GET /websites/{website_id}/apps/node/versions ### Description List installed Node versions with NVM ### Method GET ### Endpoint /websites/{website_id}/apps/node/versions ``` -------------------------------- ### Installation and Authentication Components Source: https://apidocs.enhance.com/spec/oas3-api.yaml Defines the data structures for installation requests and user authentication credentials. ```APIDOC ## Installation and Authentication Components ### Description Defines the data structures for installation requests and user authentication credentials. ### Components #### `Install` Represents an installation request. - **Type**: object - **Required**: `owner`, `locale` - **Properties**: - **owner** (LoginInfo): Reference to the `LoginInfo` schema. - **orgName** (string): The organization name. - **acceptTerms** (boolean): Indicates acceptance of terms. - **locale** (CPLocale): Reference to the `CPLocale` schema. #### `LoginInfo` User login information. - **Type**: object - **Required**: `email`, `password`, `name` - **Properties**: - **email** (string, format: email): The user's email address. - **password** (string, format: password): The user's password. - **name** (string): The user's name. #### `LoginCreds` User login credentials. - **Type**: object - **Required**: `email`, `password` - **Properties**: - **email** (string, format: email): The user's email address. - **password** (string, format: password): The user's password. - **deviceId** (string): The device ID. ``` -------------------------------- ### Install a WordPress theme Source: https://apidocs.enhance.com/ Installs a specified WordPress theme for the website. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes ### Description Install a WordPress theme. ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes ### Parameters #### Path Parameters - **org_id** (string) - Required - The organization ID. - **website_id** (string) - Required - The website ID. - **app_id** (string) - Required - The application ID. ``` -------------------------------- ### Get Installed Servers Source: https://apidocs.enhance.com/ Retrieves a list of all installed servers in the Enhance cluster. ```APIDOC ## GET /servers ### Description Retrieves a list of all installed servers in the Enhance cluster. ### Method GET ### Endpoint /servers ``` -------------------------------- ### Install server role Source: https://apidocs.enhance.com/ Installs a specified server role onto a given server. ```APIDOC ## PUT /servers/{server_id}/roles/{role} ### Description Install server role. ### Method PUT ### Endpoint /servers/{server_id}/roles/{role} ``` -------------------------------- ### Get Slave Installation Command Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves the installation script used to register more servers in the Enhance cluster. This operation requires the session holder to have Owner, SuperAdmin, or Sysadmin privileges within the MO. ```APIDOC ## GET /servers/install-cmd ### Description Returns the install script that can be used to register more servers in the Enhance cluster. ### Method GET ### Endpoint /servers/install-cmd ### Responses #### Success Response (200) - **Installation Script** (string) - The installation script. #### Error Responses - **401** - Invalid session - **403** - Insufficient privileges ``` -------------------------------- ### Get All Settings Source: https://apidocs.enhance.com/ Retrieves all current platform settings. ```APIDOC ## GET /settings ### Description Get all current settings. ### Method GET ### Endpoint /settings ``` -------------------------------- ### GET /websites/{website_id}/apps/node/possible_versions Source: https://apidocs.enhance.com/ Retrieves a list of possible Node.js versions that can be installed via nvm. ```APIDOC ## GET /websites/{website_id}/apps/node/possible_versions ### Description Get possible versions of node to install from nvm ### Method GET ### Endpoint /websites/{website_id}/apps/node/possible_versions ``` -------------------------------- ### Install a plugin Source: https://apidocs.enhance.com/ Installs a specified plugin for the WordPress application. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins ### Description Install a plugin. ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins ### Parameters #### Path Parameters - **org_id** (string) - Required - The organization ID. - **website_id** (string) - Required - The website ID. - **app_id** (string) - Required - The application ID. ``` -------------------------------- ### Install WordPress Theme Source: https://apidocs.enhance.com/spec/oas3-api.yaml Installs a specified WordPress theme for the website. Requires appropriate privileges. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes ### Description Installs a WordPress theme. ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes ### Request Body - **(object)** - Required - Details for installing the theme. ### Request Example { "example": "{\"theme\": \"my-theme-slug\"}" } ### Responses #### Success Response (200) - **(object)** - Successful theme installation. #### Error Responses - **400**: Invalid input - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### Get Website Applications Source: https://apidocs.enhance.com/spec/oas3-api.yaml Returns all applications installed on a website. Session holder must be at least a `SuperAdmin` in this org or a parent org, or be a member in this org that has access to the website. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/apps ### Description Retrieves a list of all applications currently installed on a specific website. Access is restricted to users with sufficient administrative or website access privileges. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/apps ### Parameters #### Path Parameters - **org_id** (string) - Required - The ID of the organization. - **website_id** (string) - Required - The ID of the website. ### Response #### Success Response (200) - **WebsiteAppsFullListing** - Schema containing a full listing of website applications. #### Error Responses - **400**: Invalid input - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### Fetches the site URL for a WordPress installation Source: https://apidocs.enhance.com/ Retrieves the site URL for a given WordPress installation. ```APIDOC ## GET /v2/apps/{app_id}/wordpress/url ### Description Fetches the site URL for a WordPress installation. ### Method GET ### Endpoint /v2/apps/{app_id}/wordpress/url ### Parameters #### Path Parameters - **app_id** (string) - Required - The application ID. ``` -------------------------------- ### Get Servers with Sorting and Grouping Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves a list of installed servers, with options for sorting, pagination, and grouping by server group ID. The response structure varies based on whether grouping is applied. ```json { "items": { "group1_id": [ "server1", ], "group2_id": [ "server2", ], }, "total": 4 } ``` ```json { "items": { "group2_id": [ "server3", ], "ungrouped": [ "server4" ], }, "total": 4 } ``` -------------------------------- ### Get installed servers Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves a list of all servers in the Enhance cluster, including the master and slave servers. Supports sorting, pagination, and grouping. ```APIDOC ## GET /servers ### Description Returns a list of all servers in this Enhance cluster (including the master server and all slaves). The result set of servers may optionally be sorted, paginated, as well as grouped by a server's group id. If not grouped, the returned items are a flat list of server resource objects, whereas if grouped, the returned items are an object (map) of list of servers mapped to their group ids. Grouping is applied after pagination and sorting, and in the latter case the servers within one group will be sorted. Therefore, if paginated, the last group in items, i.e. the group on the "border", may not contain all servers belonging to that group if the given limit was such as would be exceeded if all its servers were included. In such a case, the remaining servers of the group are returned in the next batch. ### Method GET ### Endpoint /servers ### Parameters #### Path Parameters #### Query Parameters - **offset** (integer) - Optional - The number of records to skip. - **limit** (integer) - Optional - The maximum number of records to return. - **sortOrder** (string) - Optional - The order in which to sort the results (e.g., 'asc', 'desc'). - **sortBy** (string) - Optional - The field by which to sort. Allowed values: [address, mailbox, forwarders, autoresponders]. ### Request Example ### Response #### Success Response (200) - **items** (object or array) - A list or grouped list of server resource objects. - **total** (integer) - The total number of servers. #### Response Example { "items": { "group1_id": [ { "id": "server1", "address": "10.0.0.1" } ], "group2_id": [ { "id": "server2", "address": "10.0.0.2" } ], "ungrouped": [ { "id": "server4", "address": "10.0.0.4" } ] }, "total": 4 } ``` -------------------------------- ### Get Possible Node Versions Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves a list of possible Node.js versions that can be installed via NVM for a website. Requires authentication. ```APIDOC ## GET /websites/{website_id}/apps/node/possible_versions ### Description Get possible versions of node to install from nvm. ### Method GET ### Endpoint /websites/{website_id}/apps/node/possible_versions ### Parameters #### Path Parameters - **website_id** (string) - Required - The ID of the website. ### Responses #### Success Response (200) - **array** of **string** - A list of available Node.js version strings. #### Error Responses - **400**: Invalid input - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### Install NVM and Default Stable Node Source: https://apidocs.enhance.com/spec/oas3-api.yaml Installs Node Version Manager (NVM) and the default stable Node.js version for a website. Requires authentication. ```APIDOC ## POST /websites/{website_id}/apps/node ### Description Install nvm and default stable node to this website. ### Method POST ### Endpoint /websites/{website_id}/apps/node ### Parameters #### Path Parameters - **website_id** (string) - Required - The ID of the website. #### Error Responses - **400**: Invalid input - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### List Installed Node Versions Source: https://apidocs.enhance.com/spec/oas3-api.yaml Lists all Node.js versions currently installed via NVM for a website. Requires authentication. ```APIDOC ## GET /websites/{website_id}/apps/node/versions ### Description List installed Node versions with NVM. ### Method GET ### Endpoint /websites/{website_id}/apps/node/versions ### Parameters #### Path Parameters - **website_id** (string) - Required - The ID of the website. ### Responses #### Success Response (200) - **array** of **string** - A list of installed Node.js version strings. #### Error Responses - **400**: Invalid input - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### Sets the site URL for a WordPress installation Source: https://apidocs.enhance.com/ Configures the site URL for a WordPress installation. ```APIDOC ## PUT /v2/apps/{app_id}/wordpress/url ### Description Sets the site URL for a WordPress installation. ### Method PUT ### Endpoint /v2/apps/{app_id}/wordpress/url ### Parameters #### Path Parameters - **app_id** (string) - Required - The application ID. ``` -------------------------------- ### InstallWpPlugin Source: https://apidocs.enhance.com/spec/oas3-api.yaml Installs a WordPress plugin by its name. Requires the pluginName to be specified. ```APIDOC ## POST /websites/apidocs_enhance/plugins/install ### Description Installs a WordPress plugin. ### Method POST ### Endpoint /websites/apidocs_enhance/plugins/install ### Parameters #### Request Body - **pluginName** (string) - Required - The name of the plugin to install. ``` -------------------------------- ### Get website WordPress plugins Source: https://apidocs.enhance.com/ Retrieves a list of installed WordPress plugins for the website. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins ### Description Get website WordPress plugins. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins ### Parameters #### Path Parameters - **org_id** (string) - Required - The organization ID. - **website_id** (string) - Required - The website ID. - **app_id** (string) - Required - The application ID. ``` -------------------------------- ### Install WordPress Plugin Source: https://apidocs.enhance.com/spec/oas3-api.yaml Installs a specific plugin into a WordPress installation. Requires appropriate permissions within the organization. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins ### Description Adds a specific plugin to a WordPress installation. Session holder must be at least a `SuperAdmin` in this org or a parent org, or be a member in this org that has access to the website. ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins ### Parameters #### Path Parameters - **org_id** (string) - Required - The organization ID. - **website_id** (string) - Required - The website ID. - **app_id** (string) - Required - The application ID. ### Request Body - **plugin_name** (string) - Required - The name of the plugin to install. ### Response #### Success Response (201) Description: Created #### Error Responses - **400**: Invalid input - **401**: Invalid session - **403**: Insufficient privileges - **404**: Not found - **409**: Already exists ``` -------------------------------- ### Install Database Role Source: https://apidocs.enhance.com/spec/oas3-api.yaml Enables the database role on a given ServerUuid. ```APIDOC ## PUT /v2/servers/{server_id}/database-role ### Description Enables the database role on a given ServerUuid. ### Method PUT ### Endpoint /v2/servers/{server_id}/database-role ### Parameters #### Path Parameters - **server_id** (string) - Required - The ID of the server. #### Query Parameters - **mysqlKind** (string) - Required - The MySQL kind to enable. ``` -------------------------------- ### Install Server Role Source: https://apidocs.enhance.com/spec/oas3-api.yaml Installs a specified role onto the server. The backup role accepts additional parameters, while others do not. For the backup role, block device size and mount point are handled, with default values and validation for existing volumes. The user must have Owner, SuperAdmin, or Sysadmin privileges. ```APIDOC ## PUT /servers/{server_id}/roles/{role} ### Description Installs a role on the server. The backup role takes additional parameters, but all other roles take no parameters. The block device size is optional and defaults to 100 GiB if not set. In this case, the mount point has to be the absolute path where the backup volume should be mounted. If there is already a valid btrfs backup volume mounted at this path, besides installing the `bkupd` service, this is a noop. In the case of an existing mount point, it is verified that it has at least the block device size bytes available. The block device is an absolute path that may or may not exist. If it exists, the block device size is used to verify if the device has at least the specified space available, if it doesn't exist, a loopback device is created with the this size. Session holder must be an `Owner`, `SuperAdmin`, or `Sysadmin` in the MO. ### Method PUT ### Endpoint /servers/{server_id}/roles/{role} ### Parameters #### Path Parameters - **server_id** (string) - Required - The ID of the server. - **role** (string) - Required - The name of the role to install. ### Request Body - **NewBackupRole** (object) - Required - Information for the backup role. ### Security - sessionCookie - bearerAuth ### Response #### Success Response (200) - Successful operation. #### Error Responses - **400**: Invalid input - **401**: Invalid session ``` -------------------------------- ### Install Specific Node Version Source: https://apidocs.enhance.com/spec/oas3-api.yaml Installs a specific version of Node.js using NVM for a website. Requires authentication. ```APIDOC ## POST /websites/{website_id}/apps/node/versions ### Description Install a specific version of Node with NVM. ### Method POST ### Endpoint /websites/{website_id}/apps/node/versions ### Parameters #### Path Parameters - **website_id** (string) - Required - The ID of the website. #### Request Body - **string** (semver) - Required - The specific Node.js version to install (e.g., "18.17.0"). #### Error Responses - **400**: Invalid input - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### GET /settings Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves all current settings for the service. Requires authentication. ```APIDOC ## GET /settings ### Description Get all current settings. ### Method GET ### Endpoint /settings ### Response #### Success Response (200) - **(SettingsFullListing)** - Successful response containing the full listing of settings. ### Response Example ```json { "example": "SettingsFullListing object" } ``` ``` -------------------------------- ### Gets the MaintenanceMode for a WordPress installation Source: https://apidocs.enhance.com/ Retrieves the maintenance mode status for a WordPress installation. ```APIDOC ## GET /v2/apps/{app_id}/wordpress/maintenance-mode ### Description Gets the MaintenanceMode for a WordPress installation. ### Method GET ### Endpoint /v2/apps/{app_id}/wordpress/maintenance-mode ### Parameters #### Path Parameters - **app_id** (string) - Required - The application ID. ``` -------------------------------- ### Get Website Setting Source: https://apidocs.enhance.com/ Retrieves the value for a particular website setting. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/settings/{setting_kind} ### Description Get the value for a particular setting. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/settings/{setting_kind} ``` -------------------------------- ### Get Websites Source: https://apidocs.enhance.com/ Retrieves a list of websites for a given organization. ```APIDOC ## GET /orgs/{org_id}/websites ### Description Get websites associated with the organization. ### Method GET ### Endpoint /orgs/{org_id}/websites ``` -------------------------------- ### Get WordPress Themes Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves a list of themes installed on the website's WordPress installation. Requires appropriate privileges. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes ### Description Returns the themes installed on website's WordPress. Session holder must be at least a `SuperAdmin` in this org or a parent org, or be a member in this org that has access to the website. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes ### Parameters #### Query Parameters - **Cache-Control** (string) - Optional - Controls caching behavior. ### Responses #### Success Response (200) - **(object)** - A list of installed WordPress themes. #### Error Responses - **400**: Invalid input - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### Create Website Application Source: https://apidocs.enhance.com/spec/oas3-api.yaml Creates a new application for a website. If the installed app is WordPress, this endpoint will enable PHP for the website if it isn't already. Session holder must be at least a `SuperAdmin` in this org or a parent org, or be a member in this org that has access to the website. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/apps ### Description Creates a new application for a website. This may also enable PHP for the website if the installed app is WordPress and PHP is not already enabled. The session holder must have appropriate administrative or website access privileges. ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/apps ### Parameters #### Path Parameters - **org_id** (string) - Required - The ID of the organization. - **website_id** (string) - Required - The ID of the website. #### Request Body - **NewWebsiteApp** - Required - Schema defining the new website application. ### Response #### Success Response (201) - **NewResourceUuid** - Schema containing the UUID of the newly created resource. #### Error Responses - **400**: Invalid input - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### Get Specified Setting Source: https://apidocs.enhance.com/ Retrieves a specific setting by its name. ```APIDOC ## GET /settings/{name} ### Description Get the specified setting. ### Method GET ### Endpoint /settings/{name} #### Path Parameters - **name** (string) - Required - The name of the setting to retrieve. ``` -------------------------------- ### Create Settings Source: https://apidocs.enhance.com/ Creates new platform settings. ```APIDOC ## POST /settings ### Description Create settings. ### Method POST ### Endpoint /settings ``` -------------------------------- ### POST /websites/{website_id}/apps/node Source: https://apidocs.enhance.com/ Installs Node.js (nvm and default stable version) for a website. ```APIDOC ## POST /websites/{website_id}/apps/node ### Description Install nvm and default stable node to this website ### Method POST ### Endpoint /websites/{website_id}/apps/node ``` -------------------------------- ### Get website WordPress themes Source: https://apidocs.enhance.com/ Retrieves a list of installed WordPress themes for a website. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes ### Description Get website WordPress themes. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes ### Parameters #### Path Parameters - **org_id** (string) - Required - The organization ID. - **website_id** (string) - Required - The website ID. - **app_id** (string) - Required - The application ID. ``` -------------------------------- ### POST /websites/{website_id}/apps/node/versions Source: https://apidocs.enhance.com/ Installs a specific version of Node.js using nvm for a website. ```APIDOC ## POST /websites/{website_id}/apps/node/versions ### Description Install a specific version of Node with NVM ### Method POST ### Endpoint /websites/{website_id}/apps/node/versions ``` -------------------------------- ### GET /websites/{website_id}/apps/persistent/{app_id} Source: https://apidocs.enhance.com/ Retrieves the log for a persistent application. ```APIDOC ## GET /websites/{website_id}/apps/persistent/{app_id} ### Description Get the log for a persistent app ### Method GET ### Endpoint /websites/{website_id}/apps/persistent/{app_id} ``` -------------------------------- ### getJoomlaInfo Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves information about a Joomla installation. This includes details specific to the Joomla setup within the organization. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/joomla/info ### Description Fetches detailed information about a specific Joomla installation. This endpoint provides insights into the Joomla site's configuration and status. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/{app_id}/joomla/info ### Parameters #### Path Parameters - **org_id** (string) - Required - The unique identifier for the organization. - **website_id** (string) - Required - The unique identifier for the website. - **app_id** (string) - Required - The unique identifier for the Joomla application. ### Response #### Success Response (200) - **(JoomlaInfo)** - An object containing detailed information about the Joomla installation. #### Error Responses - **400**: Invalid input. - **403**: Insufficient privileges. - **404**: The specified Joomla installation was not found. ``` -------------------------------- ### Generate and setup letsencrypt ssl certificates for website's domain with mail. prefix. Source: https://apidocs.enhance.com/ Generates and sets up Let's Encrypt SSL certificates for a website's domain, including the mail prefix. ```APIDOC ## POST /v2/domains/{domain_id}/letsencrypt_mail ### Description Generate and setup letsencrypt ssl certificates for website's domain with mail. prefix. ### Method POST ### Endpoint /v2/domains/{domain_id}/letsencrypt_mail ``` -------------------------------- ### Get WordPress Plugins Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves a list of all plugins installed on a WordPress website. This endpoint is separated due to potentially longer response times. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins ### Description Returns the plugins installed on wordpress. This is a separate endpoint as it is takes longer to return than the rest of the application endpoints. Session holder must be at least a `SuperAdmin` in this org or a parent org, or be a member in this org that has access to the website. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins ### Parameters #### Path Parameters - **org_id** (string) - Required - The organization ID. - **website_id** (string) - Required - The website ID. - **app_id** (string) - Required - The application ID. ### Response #### Success Response (200) - **plugins** (array) - A list of installed WordPress plugins. #### Error Responses - **400**: Invalid input - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### Get Server Statistics Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves historical server statistics between optional start and end dates. Defaults to the last 24 hours. Requires specific user roles or permissions. ```APIDOC ## GET /servers/{server_id}/historic-stats ### Description Returns server stats between the optional start and end date. Defaults to last 24 hours. Session holder must be at least a `SuperAdmin` in this org or a parent org, or be a member in this org that has access to the website. ### Method GET ### Endpoint /servers/{server_id}/historic-stats ### Parameters #### Path Parameters - **server_id** (string) - Required - The ID of the server. #### Query Parameters - **MetricsRangeStart** (string) - Optional - The start date for the statistics range. - **MetricsRangeEnd** (string) - Optional - The end date for the statistics range. ### Response #### Success Response (200) - Description: Server stats successfully queried. ``` -------------------------------- ### Generate and setup letsencrypt ssl certificates for website's domain Source: https://apidocs.enhance.com/ Generates and sets up Let's Encrypt SSL certificates for a website's domain. ```APIDOC ## POST /v2/domains/{domain_id}/letsencrypt ### Description Generate and setup letsencrypt ssl certificates for website's domain ### Method POST ### Endpoint /v2/domains/{domain_id}/letsencrypt ``` -------------------------------- ### Get Slave Registration Key Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves a registration key that can be used to install additional servers into the Enhance cluster. This operation requires the session holder to have Owner, SuperAdmin, or Sysadmin privileges within the MO. ```APIDOC ## GET /servers/registration-key ### Description Key may be used to install yet more servers in the Enhance cluster. ### Method GET ### Endpoint /servers/registration-key ### Responses #### Success Response (200) - **uuid** (string) - The registration key. #### Error Responses - **401** - Invalid session - **403** - Insufficient privileges ``` -------------------------------- ### getServerFpmSettings Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves the PHP-FPM configuration for all websites on a server. Settings are queried from the running PHP instance. Requires Owner, SuperAdmin, or Sysadmin privileges. ```APIDOC ## GET /servers/{server_id}/php/fpm ### Description Returns a list of php-fpm settings for each website on the server. Settings are queried from the running PHP instance for each website. Session holder must be an `Owner`, `SuperAdmin`, or `Sysadmin` in the MO. ### Method GET ### Endpoint /servers/{server_id}/php/fpm ### Parameters #### Path Parameters - **server_id** (string) - Required - The ID of the server. ### Responses #### Success Response (200) - **schema** (json) - Successful ``` -------------------------------- ### Get Database Role Source: https://apidocs.enhance.com/ Gets the MySQL kind for a given server. ```APIDOC ## GET /v2/servers/{server_id}/database-role ### Description Gets the MySQL kind for a given server. ### Method GET ### Endpoint /v2/servers/{server_id}/database-role #### Path Parameters - **server_id** (string) - Required - The unique identifier of the server. ``` -------------------------------- ### Sets the MaintenanceMode for a WordPress installation Source: https://apidocs.enhance.com/ Configures the maintenance mode status for a WordPress installation. ```APIDOC ## PUT /v2/apps/{app_id}/wordpress/maintenance-mode ### Description Sets the MaintenanceMode for a WordPress installation. ### Method PUT ### Endpoint /v2/apps/{app_id}/wordpress/maintenance-mode ### Parameters #### Path Parameters - **app_id** (string) - Required - The application ID. ``` -------------------------------- ### Create Preview Domain Source: https://apidocs.enhance.com/spec/oas3-api.yaml Creates a preview domain for the given website. If a preview domain already exists, it returns the existing one. Errors if a preview domain cannot be created. Returns 200 if an existing domain is returned and 201 if a new one is created. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/preview_domain ### Description Creates a preview domain for the given website and returns its full domain. If a preview domain already exists, returns that instead. Will error if a preview domain cannot be created. Returns 200 if an existing preview domain is returned and 201 if one has been created. ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/preview_domain ### Parameters #### Path Parameters - **org_id** (string) - Required - The organization ID. - **website_id** (string) - Required - The website ID. ### Responses #### Success Response (200) Description: Preview domain existed Content: application/json: schema: type: string #### Success Response (201) Description: Domain successfully created Content: application/json: schema: type: string #### Error Responses - **400**: Invalid input - **401**: Invalid session - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### POST /orgs/{org_id}/websites/{website_id}/apps Source: https://apidocs.enhance.com/ Creates a new website application. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/apps ### Description Create website applications ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/apps ``` -------------------------------- ### Get Database Role MySQL Kind Source: https://apidocs.enhance.com/spec/oas3-api.yaml Gets the MySQL kind for a given server. ```APIDOC ## GET /v2/servers/{server_id}/database-role ### Description Gets the MySQL kind for a given server. ### Method GET ### Endpoint /v2/servers/{server_id}/database-role ### Parameters #### Path Parameters - **server_id** (string) - Required - The ID of the server. #### Query Parameters - **mysqlKind** (string) - Required - The MySQL kind to retrieve. ``` -------------------------------- ### Create Persistent Application Source: https://apidocs.enhance.com/spec/oas3-api.yaml Creates an application that will be started automatically within the website container and restarted if it fails. Set a port to proxy from the web server to the running application. ```APIDOC ## POST /websites/{website_id}/apps/persistent ### Description Create an application that will be started automatically within the website container and restarted if it fails. Set a port to proxy from the web server to the running application. ### Method POST ### Endpoint /websites/{website_id}/apps/persistent ### Parameters #### Path Parameters - **website_id** (string) - Required - The website ID. #### Request Body - **PersistentApp** (object) - Required - Schema for a persistent application. ### Response #### Success Response (201) Description: Successful #### Error Response - **400** (Invalid input) - **403** (Insufficient privileges) ``` -------------------------------- ### Create a website backup Source: https://apidocs.enhance.com/spec/oas3-api.yaml Creates a new full website backup. This is a long-running operation. Backups can include various components like home directory, databases, and optionally emails. Session holder must be at least a `SuperAdmin` in this org or a parent org, or be a member in this org that has access to the website. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/backups ### Description Creates a new full website backup. This is a long running operation and the request doesn't return until all backups are finished, or an error occurs. If you want to see the backup progress, you can periodically query the backup status via `getWebsiteBackupStatus`. Backups consists of several components, and a component is the smallest granularity of a backup. The components are: backing up of the website's home directory, the website's mysql databases, and the website's emails. The backups may be partial, that is, some out of all backup components may succeeded, but e.g. the backup of the mysql databases may fail. In both cases, the backup snapshot is still created, and the mysql backups are marked as failed for the backup record. Email backups are not done automatically, as they need not be backed up in most cases (due to the expectation that customers would want to backup and then roll back a website after filesystem or database changes, which wouldn't concern emails). Doing so redundantly is time consuming so it is skipped by default, but emails may be backed up if the `includeEmails` query parameter is set to true. If the backup fails altogether, this endpoint still returns a 201 Created, but in this case only the metadata in `orchd`'s db is inserted, no actual backup snapshot is created. This is for information purposes, such a backup, perhaps needless to say, cannot be restored. Session holder must be at least a `SuperAdmin` in this org or a parent org, or be a member in this org that has access to the website. ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/backups ### Parameters #### Path Parameters - **org_id** (string) - Required - The organization ID. - **website_id** (string) - Required - The website ID. #### Query Parameters - **includeEmails** (boolean) - Optional - The boolean flag used to include emails in the backup. Defaults to false. #### Request Body - **BackupOptions** (object) - Required - Options for the backup. ### Response #### Success Response (201) - **Backup** (object) - The created backup metadata. ``` -------------------------------- ### List all server import settings Source: https://apidocs.enhance.com/spec/oas3-api.yaml Lists all configured settings for server imports within an organization. This provides an overview of existing import configurations. ```APIDOC ## GET /orgs/{org_id}/import/server/settings ### Description List all server import settings. ### Method GET ### Endpoint /orgs/{org_id}/import/server/settings ### Parameters #### Path Parameters - **org_id** (string) - Required - The ID of the organization. ### Response #### Success Response (200) - **ImportServerSettingsFullListing** (object) - The schema for the full listing of server import settings. #### Error Responses - **401**: Invalid session - **403**: Insufficient privileges ``` -------------------------------- ### Trigger discovery of WP installations Source: https://apidocs.enhance.com/ Triggers a discovery process for WordPress installations within a specific website and organization. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/apps/wordpress ### Description Trigger discovery of WP installations. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/wordpress ### Parameters #### Path Parameters - **org_id** (string) - Required - The organization ID. - **website_id** (string) - Required - The website ID. ``` -------------------------------- ### GET /logins/ui-preferences Source: https://apidocs.enhance.com/ Gets the UI preferences for a login. This endpoint retrieves the current interface customization settings for a user. ```APIDOC ## GET /logins/ui-preferences ### Description Get UI prefereces for login. ### Method GET ### Endpoint /logins/ui-preferences ``` -------------------------------- ### Download my.cnf Source: https://apidocs.enhance.com/ Downloads the my.cnf configuration file for a given server. ```APIDOC ## GET /v2/servers/{server_id}/my-cnf ### Description Downloads the my.cnf configuration file for a given server. ### Method GET ### Endpoint /v2/servers/{server_id}/my-cnf #### Path Parameters - **server_id** (string) - Required - The unique identifier of the server. ``` -------------------------------- ### GET /login Source: https://apidocs.enhance.com/ Retrieves information about the current login. This endpoint is typically used to get details of the authenticated user. ```APIDOC ## GET /login ### Description Get login info. ### Method GET ### Endpoint /login ``` -------------------------------- ### Push Website Live Source: https://apidocs.enhance.com/ Makes a staging website live. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/push-live ### Description Making a staging website live. ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/push-live ``` -------------------------------- ### getSetting Source: https://apidocs.enhance.com/spec/oas3-api.yaml Retrieves the value of a specific setting by its name. Requires a valid session or bearer token. ```APIDOC ## GET /settings/{name} ### Description Get the specified setting. ### Method GET ### Endpoint /settings/{name} ### Parameters #### Path Parameters - **name** (string) - Required - The name of the setting to retrieve. ### Response #### Success Response (200) - **value** (Setting) - The value of the setting. #### Error Responses - **401**: Invalid session - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### Create bulk website role migrations Source: https://apidocs.enhance.com/spec/oas3-api.yaml Creates multiple new role website migrations from one server to another, grouped by a session ID. Returns 206 if some migrations fail to schedule, or 400 if all fail. ```APIDOC ## POST /migrations/sessions ### Description Creates multiple new role website migrations from one server to another, grouped by a session ID. Returns 206 if some migrations fail to schedule, or 400 if all fail. ### Method POST ### Endpoint /migrations/sessions ### Request Body - **Migrations details** (array) - Required - An array of migration details. - Each item should conform to the **NewMigrationDetails** schema. ### Response #### Success Response (201) - **MigrationSessionCreationOk** (object) - Schema indicating successful creation of all migrations. #### Partial Success Response (206) - **MigrationSessionCreationOk** (object) - Schema indicating some migrations were created, with details in the body. #### Failure Response (400) - **MigrationSessionCreationError** (object) - Schema indicating all migrations failed to create, with error details in the body. #### Error Response - **401**: Invalid session - **403**: Insufficient privileges ``` -------------------------------- ### Create PostgreSQL Database Source: https://apidocs.enhance.com/ Creates a PostgreSQL database for a website. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/postgresql-dbs ### Description Create a PostgreSQL database for website. ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/postgresql-dbs #### Path Parameters - **org_id** (string) - Required - The ID of the organization. - **website_id** (string) - Required - The ID of the website. ``` -------------------------------- ### Trigger WordPress Discovery Source: https://apidocs.enhance.com/spec/oas3-api.yaml Invoking this endpoint triggers the discovery of WordPress installations that were made manually or outside of orchd APIs, and adds their installation information to the database. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/apps/wordpress ### Description Initiates a process to discover and register WordPress installations associated with a website that may not have been initially set up through orchd's standard procedures. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/wordpress ### Parameters #### Path Parameters - **org_id** (string) - Required - The ID of the organization. - **website_id** (string) - Required - The ID of the website. ### Response #### Success Response (200) - **array of WpInstallation** - A list of discovered WordPress installations. #### Error Responses - **400**: Invalid input - **403**: Insufficient privileges - **404**: Not found ``` -------------------------------- ### Get Website Source: https://apidocs.enhance.com/ Retrieves details for a specific website. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id} ### Description Get website details. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id} ``` -------------------------------- ### POST /websites/{website_id}/apps/persistent Source: https://apidocs.enhance.com/ Creates a persistent application for a website. ```APIDOC ## POST /websites/{website_id}/apps/persistent ### Description Create a persistent application ### Method POST ### Endpoint /websites/{website_id}/apps/persistent ``` -------------------------------- ### Get subscription Source: https://apidocs.enhance.com/ Retrieves details for a specific subscription. ```APIDOC ## GET /orgs/{org_id}/subscriptions/{subscription_id} ### Description Get subscription ### Method GET ### Endpoint /orgs/{org_id}/subscriptions/{subscription_id} ``` -------------------------------- ### Get Migration Log Source: https://apidocs.enhance.com/ Retrieves the log for a specific migration. ```APIDOC ## GET /migrations/{migrationId}/log ### Description Get the log for a migration. ### Method GET ### Endpoint /migrations/{migrationId}/log #### Path Parameters - **migrationId** (string) - Required - The ID of the migration. ``` -------------------------------- ### Create Bulk Website Role Migrations Source: https://apidocs.enhance.com/ Creates bulk website role migrations. ```APIDOC ## POST /migrations/sessions ### Description Create bulk website role migrations. ### Method POST ### Endpoint /migrations/sessions ``` -------------------------------- ### Get Single Migration Source: https://apidocs.enhance.com/ Retrieves a single migration by its ID. ```APIDOC ## GET /migrations/{migrationId} ### Description Get a single migration. ### Method GET ### Endpoint /migrations/{migrationId} #### Path Parameters - **migrationId** (string) - Required - The ID of the migration. ``` -------------------------------- ### Create Website Preview Domain Source: https://apidocs.enhance.com/ Creates a preview domain for a website. ```APIDOC ## POST /orgs/{org_id}/websites/{website_id}/preview ### Description Create a preview domain. ### Method POST ### Endpoint /orgs/{org_id}/websites/{website_id}/preview ``` -------------------------------- ### Get Email Autoresponders Source: https://apidocs.enhance.com/ Retrieves email account autoresponders. ```APIDOC ## GET /email-client/autoresponders ### Description Get email account autoresponder. ### Method GET ### Endpoint /email-client/autoresponders ``` -------------------------------- ### Create Website Source: https://apidocs.enhance.com/ Creates a new website or clones an existing one within a given organization. ```APIDOC ## POST /orgs/{org_id}/websites ### Description Create a new website or clone an existing one. ### Method POST ### Endpoint /orgs/{org_id}/websites ``` -------------------------------- ### Get Joomla Info Source: https://apidocs.enhance.com/ Retrieves information about a Joomla application. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/joomla/info ### Description Get Joomla info. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/apps/{app_id}/joomla/info #### Path Parameters - **org_id** (string) - Required - The ID of the organization. - **website_id** (string) - Required - The ID of the website. - **app_id** (string) - Required - The ID of the application. ``` -------------------------------- ### Get Website Metrics Source: https://apidocs.enhance.com/ Retrieves metrics for a given website. ```APIDOC ## GET /orgs/{org_id}/websites/{website_id}/metrics ### Description Get website metrics. ### Method GET ### Endpoint /orgs/{org_id}/websites/{website_id}/metrics #### Path Parameters - **org_id** (string) - Required - The ID of the organization. - **website_id** (string) - Required - The ID of the website. ```