v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB

WordPress: Installations

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.

get/api/hosting/v1/wordpress/installations

Query parameters

usernamestring nullable

Example:cl_user123

Filter by specific username

domainstring nullable

Example:example.com

Filter by domain name (exact match)

ownership'owned' | 'managed' | 'all' nullable

Example:owned

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

Response

Success response

idstring

WordPress installation (software) id

usernamestring

Hosting account username

domainstring

Domain the installation belongs to

site_titlestring

WordPress site title

urlstring

WordPress site URL

directorystring

Installation directory

languagestring

WordPress locale

loginstring

WordPress admin username

emailstring

WordPress admin email

is_validboolean

Whether the installation is considered valid

validation_errorstring nullable

Reason the installation is invalid, if any

created_atstring date-time

Installation creation timestamp

Example response

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