HostingWordpressApi.md

Hostinger\HostingWordpressApi

All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path.

Method	HTTP request	Description
installWordPressV1()	POST /api/hosting/v1/accounts/{username}/wordpress/installations	Install WordPress
listWordPressInstallationsV1()	GET /api/hosting/v1/wordpress/installations	List WordPress installations

installWordPressV1()

installWordPressV1($username, $hostingV1WordpressInstallWordpressRequest): \Hostinger\Model\CommonSuccessEmptyResource

Install WordPress

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingWordpressApi(config: $config);
$username = u123456789; // string
$hostingV1WordpressInstallWordpressRequest = new \Hostinger\Model\HostingV1WordpressInstallWordpressRequest(); // \Hostinger\Model\HostingV1WordpressInstallWordpressRequest

try {
    $result = $apiInstance->installWordPressV1($username, $hostingV1WordpressInstallWordpressRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingWordpressApi->installWordPressV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string
hostingV1WordpressInstallWordpressRequest	\Hostinger\Model\HostingV1WordpressInstallWordpressRequest

Return type

\Hostinger\Model\CommonSuccessEmptyResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listWordPressInstallationsV1()

listWordPressInstallationsV1($username, $domain, $ownership): \Hostinger\Model\HostingV1WordpressWordpressInstallationResource[]

List WordPress installations

List WordPress installations accessible to the authenticated client. Use this endpoint to discover existing WordPress installations and to poll for installation status after calling the install endpoint. When a newly requested installation appears in this list, WordPress is ready. Filter by username and domain to narrow results to a specific website. Each installation includes a valid flag and, when invalid, a validationError describing why.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingWordpressApi(config: $config);
$username = cl_user123; // string | Filter by specific username
$domain = example.com; // string | Filter by domain name (exact match)
$ownership = owned; // string | Filter by ownership type. Defaults to \"owned\". Use \"all\" to include both owned and managed installations.

try {
    $result = $apiInstance->listWordPressInstallationsV1($username, $domain, $ownership);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingWordpressApi->listWordPressInstallationsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string	Filter by specific username	[optional]
domain	string	Filter by domain name (exact match)	[optional]
ownership	string	Filter by ownership type. Defaults to "owned". Use "all" to include both owned and managed installations.	[optional]

Return type

\Hostinger\Model\HostingV1WordpressWordpressInstallationResource[]

[Back to top] [Back to API list] [Back to Model list] [Back to README]