hosting_installWordPressV1
Install WordPress on an existing hosting website. Provide domain, site title, and admin credentials. Asynchronous install queue; check job status via API.
Instructions
Install WordPress on an existing website.
The website must already exist before calling this endpoint. To create a new website first, use POST /api/hosting/v1/websites and poll GET /api/hosting/v1/websites until it appears.
Call GET /api/hosting/v1/wordpress/installations filtered by username and
domain before proceeding to check whether WordPress is already installed on
the target domain/path. If WordPress already exists and overwrite is false
(the default), the async job will fail.
This operation is asynchronous: a successful response only means the install job has been queued, not that WordPress is ready. Installation typically takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations filtered by username and domain to track progress. When the installation appears in that list, WordPress is ready.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | username parameter | |
| domain | Yes | Domain of the existing website where WordPress will be installed | |
| site_title | Yes | Title of the WordPress site | |
| language | No | WordPress locale. Defaults to en_US when omitted. | |
| directory | No | Relative directory to install WordPress into. Defaults to the website root when omitted. | |
| overwrite | No | When false (default), does not replace an existing installation. If WordPress is already installed on the domain/path, the async install job fails unless true. | |
| auto_updates | No | WordPress core auto-update policy | |
| version | No | WordPress core version to install. If omitted, the latest core version compatible with the account vhost PHP version is selected. | |
| credentials | Yes | WordPress admin credentials | |
| database | No | Optional. If the named database already exists, it will be used for this WordPress install. Otherwise a new database is created with a generated name and random credentials. |