List WordPress installations

List WordPress installations accessible to the authenticated client.

List WordPress installations

get

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.

Authorizations

AuthorizationstringRequired

API Token authentication

Query parameters

usernamestring · nullableOptional

Filter by specific username

Example: cl_user123

domainstring · nullableOptional

Filter by domain name (case-insensitive substring match)

Example: example.com

ownershipstring · enum · nullableOptional

Filter by ownership type. Defaults to "owned". Use "all" to include both owned and managed installations.

Example: ownedPossible values:

Responses

200

Success response

application/json

Array of WordPress.V1.Installations.WordPressInstallationResource

idstringOptional

WordPress installation (software) id

Example: 123

usernamestringOptional

Hosting account username

Example: u123456789

domainstringOptional

Domain the installation belongs to

Example: example.com

site_titlestringOptional

WordPress site title

Example: My site

urlstringOptional

WordPress site URL

Example: https://example.com

directorystringOptional

Installation directory

Example: public_html

languagestringOptional

WordPress locale

Example: en_US

loginstringOptional

WordPress admin username

Example: admin

emailstringOptional

WordPress admin email

Example: [e-mail]

is_validbooleanOptional

Whether the installation is considered valid

Example: true

validation_errorstring · nullableOptional

Reason the installation is invalid, if any

Example: Invalid domain

created_atstring · date-timeOptional

Installation creation timestamp

Example: 2022-01-01T00:00:00Z

401

Unauthenticated response

application/json

500

Error response

application/json

get/api/hosting/v1/wordpress/installations

GET /api/hosting/v1/wordpress/installations HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123",
    "username": "u123456789",
    "domain": "example.com",
    "site_title": "My site",
    "url": "https://example.com",
    "directory": "public_html",
    "language": "en_US",
    "login": "admin",
    "email": "[e-mail]",
    "is_valid": true,
    "validation_error": "Invalid domain",
    "created_at": "2022-01-01T00:00:00Z"
  }
]