Plesk Obsidian

https://docs.plesk.com/en-US/obsidian
Admin
Plesk Obsidian is a web hosting control panel that simplifies the management of websites, servers,...
Tokens:2,787,835
Snippets:26,819
Trust Score:10
Update:4 days ago
Show doc for...
Tokens:
Raw
### Install Template Command Examples

Source: https://docs.plesk.com/en-US/obsidian/cli-win/using-command-line-utilities/skeletonexe-virtual-host-templates.60809

Examples for using the --install or -i command to apply a template from a file.

```text
plesk bin skeleton.exe --install JDoe -filename D:\skeletons\siteskeleton.zip -force-type zip
```

```text
plesk bin skeleton.exe -i JDoe -filename siteskeleton -force-type zip
```

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

### branding_theme.exe --install Command Examples

Source: https://docs.plesk.com/en-US/obsidian/cli-win/using-command-line-utilities/branding_themeexe-plesk-branding.66507

Examples for installing themes for the server administrator or a specific reseller.

```text
plesk bin branding_theme.exe --install -vendor admin -source c:\tmp\custom_theme.zip
```

```text
plesk bin branding_theme.exe --install -vendor "JDoe" -source c:\tmp\custom_theme.zip
```

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

### Example of installing a reseller theme

Source: https://docs.plesk.com/en-US/obsidian/administrator-guide/customizing-the-plesk-interface/using-custom-themes/installing-themes-to-plesk.70908

A concrete example of installing a theme for the reseller 'JDoe' from a specific file path.

```bash
plesk bin branding_theme --install -vendor "JDoe" -source /usr/local/psa/theme.zip
```

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

### Filename Option Example

Source: https://docs.plesk.com/en-US/obsidian/cli-win/using-command-line-utilities/skeletonexe-virtual-host-templates.60809

Example showing the use of the -filename option during installation.

```text
plesk bin skeleton.exe -i JDoe -filename D:\skeletons\siteskeleton -force-type zip
```

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

### Launch the Installer Web Interface

Source: https://docs.plesk.com/en-US/obsidian/deployment-guide/plesk-installation-and-upgrade-on-single-server/installing-plesk-using-installer-gui/installing-plesk-for-linux-using-installer-gui.76446

Run the installer script with the --web-interface flag to start the interactive web-based installation process.

```bash
./plesk-installer --web-interface
```

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

### Install Custom Theme Example

Source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference/managing-user-interface-custom-buttons/installing-custom-theme.66936

An example request packet to install a custom theme file located at /tmp/branding-theme.zip for the reseller JDoe, followed by the corresponding success response.

```xml
<packet>
    <ui>
        <branding-theme-install>
            <filter>
                <vendor-login>JDoe</vendor-login>
            </filter>
            <path>/tmp/branding-theme.zip</path>
        </branding-theme-install>
    </ui>
</packet>
```

```xml
<packet>
    <ui>
        <branding-theme-install>
            <result>
                <status>ok</status>
                <filter-id>JDoe</filter-id>
                <id>1234</id>
            </result>
        </branding-theme-install>
    </ui>
</packet>
```

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

### Install an extension from a specific path

Source: https://docs.plesk.com/en-US/obsidian/extensions-guide/plesk-extensions-basics/how-to-create-and-install-extensions.76094

Example command to install an extension from a local Windows file path.

```bash
plesk bin extension -i C:\Users\Administrator\my_extension-1.0-1.zip
```

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

### Install virtual host template

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/using-command-line-utilities/skeleton-virtual-host-templates.40784

Example command to install a virtual host template from a ZIP file for a specific client.

```bash
plesk bin skeleton --install JDoe -filename /usr/local/skeletons/siteskeleton -force-type zip
```

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

### View Installer Help

Source: https://docs.plesk.com/en-US/obsidian/deployment-guide/plesk-installation-and-upgrade-on-multiple-servers/installing-plesk-in-unattended-mode/installing-plesk-for-windows-in-unattended-mode.76511

Run this command to display the complete list of available installer options.

```bash
plesk-installer.exe --help
```

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

### Create a new domain with hosting

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/using-command-line-utilities/site-sites.67067

Sets up a new domain example.com in the testdomain.tst subscription and enables hosting.

```bash
plesk bin site --create example.com -webspace-name testdomain.tst -hosting true
```

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

### Create Command Examples

Source: https://docs.plesk.com/en-US/obsidian/cli-win/using-command-line-utilities/admin_aliasexe-additional-administrator-accounts.60887

Examples for creating an account using the --create or -c flags.

```bash
plesk bin admin_alias.exe --create john_doe -passwd 'sample' -contact 'John Doe' -email john_doe@example.com
plesk bin admin_alias.exe -c john_doe -passwd 'sample' -contact 'John Doe' -email john_doe@example.com
```

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

### Changing GUIDs of All Customers

Source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference/managing-customer-accounts/setting-customer-account-properties.28792

Example request and response for updating the GUIDs of all customer accounts.

```xml
<packet>
    <customer>
        <set>
            <filter/>
            <values>
                <gen_info>
                    <guid/>
                </gen_info>
            </values>
        </set>
    </customer>
</packet>
```

```xml
<packet>
    <customer>
        <set>
            <result>
                <status>ok</status>
                <filter-id>3</filter-id>
                <id>3</id>
            </result>
            <result>
                <status>ok</status>
                <filter-id>4</filter-id>
                <id>4</id>
            </result>
        </set>
    </customer>
</packet>
```

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

### Create a hosting plan example

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/38365

Creates a hosting plan named 'Personal Sites' with 500MB disk space and 1GB traffic.

```bash
plesk bin service_plan -c "Personal Sites" -hosting true -disk_space 500M -max_traffic 1G
```

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

### Changing a Customer GUID

Source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference/managing-customer-accounts/setting-customer-account-properties.28792

Example request and response for changing a specific customer's GUID.

```xml
<packet>
    <customer>
        <set>
            <filter>
                <login>MyClient</login>
            </filter>
            <values>
                <gen_info>
                    <guid/>
                </gen_info>
            </values>
        </set>
    </customer>
</packet>
```

```xml
<packet>
    <customer>
        <set>
            <result>
                <status>ok</status>
                <filter-id>MyClient</filter-id>
                <id>4</id>
            </result>
        </set>
    </customer>
</packet>
```

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

### Enable database server selection

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/37982

Allows the owner of the subscription example.com to select a database server during creation of a new database.

```bash
plesk bin subscription_settings -u example.com -select_db_server true
```

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

### Performing Initial Server Setup

Source: https://docs.plesk.com/en-US/obsidian/api-rpc

Perform initial server setup.

```APIDOC
## Performing Initial Server Setup

### Description
Perform initial server setup.

### Method
RPC

### Endpoint
Not specified

### Parameters
Not specified

### Request Example
Not specified

### Response
Not specified

### Response Example
Not specified
```

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

### initial_setup

Source: https://docs.plesk.com/en-US/obsidian/api-rpc/36912

Performs the initial server setup by specifying administrator personal information, changing the default password, and optionally setting the full host name. This operation is only allowed immediately after installation.

```APIDOC
## initial_setup

### Description
Performs the initial server setup after installing Plesk. This includes specifying administrator personal information, changing the default password, and optionally specifying the full host name.

### Method
XML API operation

### Endpoint
Not applicable (XML API)

### Parameters
#### Request Packet Structure
- **admin** (adminType) - Required - Collection of data describing Plesk Administrator's personal info.
- **password** (serverPassword) - Required - New Plesk Administrator's password (5 to 14 characters).
- **server_name** (string) - Optional - Full host name.
- **trial_license** - Optional - Available starting with Plesk 17.8.10. Used to install a full-featured trial license.

### Request Example
<packet>
    <server>
        <initial_setup>
            <admin>...</admin>
            <password>...</password>
            <server_name>...</server_name>
        </initial_setup>
    </server>
</packet>

### Response
Not documented in the source.

### Notes
- Using this operation later to change administrator password or personal info is prohibited. Use the set operation instead.
- When creating request packets, put nodes and elements in the order they follow in the packet structure.
```

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

### Install PHP 5.6 via CLI

Source: https://docs.plesk.com/en-US/obsidian/administrator-guide/plesk-administration/securing-plesk/plesk-for-linux-securing-outdated-php-versions.80043

An example command to install the secured version of PHP 5.6.

```bash
plesk ext tuxcare-php --install-configure -version 5.6
```

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

### Starting PostgreSQL and MySQL Database Services

Source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference/managing-plesk-services.36910

Example request and response packets for starting database services, including a scenario where one service fails to start.

```xml
<packet>
    <server>
        <srv_man>
            <id>postgresql</id>
            <operation>start</operation>
        </srv_man>
        <srv_man>
            <id>mysql</id>
            <operation>start</operation>
        </srv_man>
    </server>
</packet>
```

```xml
<packet>
    <server>
        <srv_man>
            <result>
                <status>ok</status>
                <id>postgresql</id>
            </result>
        </srv_man>
        <srv_man>
            <result>
                <status>error</status>
                <errcode>1013</errcode>
                <errtext>Service 'mysql' does not exist</errtext>
            </result>
        </srv_man>
    </server>
</packet>
```

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

### Launch Plesk Installer GUI

Source: https://docs.plesk.com/en-US/obsidian/deployment-guide/plesk-installation-and-upgrade-on-single-server/upgrading-plesk-using-installer-gui/upgrading-plesk-for-linux-using-installer-gui.76760

Commands to download the installer, set execution permissions, and start the graphical interface.

```bash
wget https://autoinstall.plesk.com/plesk-installer
chmod +x plesk-installer
./plesk-installer --web-interface
```

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

### init_conf.exe --init example

Source: https://docs.plesk.com/en-US/obsidian/cli-win/using-command-line-utilities/init_confexe-server-initial-configuration-and-administrator%E2%80%99s-personal-info.25731

Sets a shared IP address, host name, administrator name, and password in one command.

```plaintext
plesk bin init_conf.exe --init -shared_ips add:192.0.2.0 -hostname host.example.com -name Administrator -passwd MyPass

```

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

### Launch Plesk Installer Console

Source: https://docs.plesk.com/en-US/obsidian/deployment-guide/plesk-installation-and-upgrade-on-single-server/installing-plesk-using-installer-console/installing-plesk-for-windows-using-installer-console.76449

Run this command in the Windows command prompt to start the interactive installation console.

```cmd
plesk-installer.exe --console
```

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

### Example CORS Configuration in panel.ini

Source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-rest-api.79359

An example configuration allowing CORS only for example.com using GET and POST methods.

```ini
[ext-rest-api]
cors.origin = example.com
cors.methods = GET,POST
```

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

### Create Subdomain Example

Source: https://docs.plesk.com/en-US/obsidian/cli-win/using-command-line-utilities/subdomainexe-subdomains.25760

Creates the sample.example.com subdomain with a 250MB disk quota and SSI support enabled.

```bash
plesk bin subdomain.exe --create sample -domain example.com -hard_quota 250M -ssi true
```

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

### Enable FTP backups

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/37982

Allows the owner of the subscription example.com to back up and restore websites, and keep the data on custom FTP servers.

```bash
plesk bin subscription_settings -u example.com -allow_ftp_backups true
```

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

### Install Fail2Ban Component Request

Source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference/managing-plesk-components/installing-components.40336

Example request packet to install the IP Address Banning (Fail2Ban) component.

```xml
<packet>
    <updater>
        <install-component>
            <update-id>PLESK_12_5_30</update-id>
            <component-id>fail2ban</component-id>
        </install-component>
    </updater>
</packet>
```

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

### Create Customer Account Example

Source: https://docs.plesk.com/en-US/obsidian/cli-win/using-command-line-utilities/customerexe-customer-accounts.25736

Example command to create a customer account with specific settings for name, password, notifications, IIS application pool, and CPU usage.

```bash
plesk bin customer.exe --create JohnDoe -name "John Doe" -passwd MyPass -notify false -iis_app_pool true -cpu_usage 7
```

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

### Access Installer Web Interface

Source: https://docs.plesk.com/en-US/obsidian/deployment-guide/plesk-installation-and-upgrade-on-single-server/upgrading-plesk-using-installer-gui/upgrading-plesk-for-linux-using-installer-gui.76760

The URL pattern to access the graphical installer interface in a web browser after starting the service.

```text
https://<server hostname or IP address>:8447
```

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

### Enable local backups

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/37982

Allows the owner of the subscription example.com to back up and restore websites, and keep the data on the server.

```bash
plesk bin subscription_settings -u example.com -allow_local_backups true
```

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

### Example panel.ini Blacklist Configuration

Source: https://docs.plesk.com/en-US/obsidian/administrator-guide/78328

Example configuration to prohibit the installation of Amazon Route 53 and Dropbox Backup extensions.

```ini
[extensions]
blacklist = route53,dropbox-backup
```

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

### Allow WP Toolkit syncing

Source: https://docs.plesk.com/en-US/obsidian/cli-win/using-command-line-utilities/subscription_settingsexe-hosting-subscription-settings.25739

Allows the owner of the example.com subscription to synchronize WordPress installations using the WP Toolkit extension.

```bash
plesk bin subscription_settings.exe -u example.com -ext_permission_wp_toolkit_manage_syncing true
```

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

### plesk ext monitoring --installation

Source: https://docs.plesk.com/en-US/obsidian/cli-win/80001

Manages the Monitoring installation, including getting status, fixing issues, and detecting hardware changes.

```APIDOC
## plesk ext monitoring --installation

### Description
Manages the Monitoring installation. Operations include getting status, fixing issues, and detecting hardware changes.

### Command
`plesk ext monitoring --installation <operation> [options]`

### Operations
- `--get-status` - Get the installation status.
- `--fix` - Fix installation issues.
- `--detect-hardware-changes` - Detect hardware changes and reflect them.

### Example
To check for changes made to the server hardware and reflect them (if any):
```
plesk ext monitoring --installation --detect-hardware-changes
```
```

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

### Enable hosting for a domain

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/using-command-line-utilities/subscription-subscriptions.37768

Enables hosting for the domain example.com with the specified IP address, login, and password.

```bash
plesk bin subscription -u example.com -login jdoe -passwd sample -hosting true -ip 192.0.2.87
```

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

### Enable Java web application management

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/37982

Allows the owner of the subscription example.com to install and manage Java applications.

```bash
plesk bin subscription_settings -u example.com -manage_webapps true
```

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

### Get subscription information with PHP library

Source: https://docs.plesk.com/en-US/obsidian/extensions-guide/plesk-features-available-for-extensions/communicate-with-plesk-api/xml-api.71086

This example achieves the same goal as the XML API protocol example using the Plesk PHP library.

```php
$client = new \PleskX\Api\InternalClient();

echo 'Domain name: ' . $client->webspace()->get('id', 170)->name;
```

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

### Example: Get Databases by Subscription Name

Source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference/managing-databases/available-filters.34404

An example request packet that retrieves information about databases on a subscription named MyDomain.com using the webspace-name filter.

```APIDOC
## Example: Get Databases by Subscription Name

### Description
This example shows a request packet that retrieves information about databases on a subscription named MyDomain.com.

### Request Packet
```xml
<packet>
    <database>
        <get-db>
            <filter>
                <webspace-name>MyDomain.com</webspace-name>
            </filter>
        </get-db>
    </database>
</packet>
```

### Response Filter ID
When filters are used in operations such as del-db-user, get-db, get-db-users, get-default-user, del-db, or assign-to-subscription, the response packet includes a filter-id node that returns the filtering rule parameter. This can be the database ID, subscription name, subscription ID, or database user ID. The filter-id node is of data type anySimple and is used to trace request parameters in case of an error.
```

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

### Enable hosting type management

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/37982

Allows the owner of the subscription example.com to manage hosting types.

```bash
plesk bin subscription_settings -u example.com -manage_hosting_type true
```

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

### GET

Source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference/managing-locales.40658

Retrieves information about the language packs installed on the Plesk server.

```APIDOC
## GET

### Description
Retrieves information about the language packs installed on the Plesk server.

### Operator
`<locale>`

### Operation
`GET`

### XML Schema
`locale.xsd`

### Plesk Version
Plesk 12.0 and later

### XML API Version
1.6.6.0 and later

### Plesk User
Plesk Administrator
```

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

### Install WordPress with all automatic updates enabled

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/78685

Installs WordPress on example.com with both minor and major automatic updates enabled.

```bash
plesk ext wp-toolkit --install -domain-name example.com -auto-updates true
```

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

### Corrected Filter with Separate Get Sections

Source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference/managing-subscriptions/available-filters.33891

Example showing how to fix the invalid filter by using two separate get sections, each with a single filter parameter.

```APIDOC
## [XML] webspace.get (Corrected Example)

### Description
Demonstrates the correct way to filter by name and id by using two separate get sections.

### Method
XML API request

### Endpoint
webspace.get

### Parameters
#### Filter Node Parameters
- **name** (string) - Optional - Subscription name.
- **id** (integer) - Optional - Subscription ID.

### Request Example
<packet>
    <webspace>
        <get>
            <filter>
                <name>example.com</name>
            </filter>
            <dataset>
                <hosting/>
            </dataset>
        </get>
        <get>
            <filter>
                <id>126</id>
            </filter>
            <dataset>
                <hosting/>
            </dataset>
        </get>
    </webspace>
</packet>
```

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

### Enable hosting

Source: https://docs.plesk.com/en-US/obsidian/cli-win/67068

Enables hosting for the domain example.com.

```bash
plesk bin site.exe --update example.com -hosting true
```

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

### View utility help with --help

Source: https://docs.plesk.com/en-US/obsidian/cli-linux/37843

Displays help information for the init_conf utility.

```bash
plesk bin init_conf --help
```

```bash
plesk bin init_conf -h
```
Tokens:
Raw