Skip to content

List WordPress sites

GET /api/v2/shared-hosting/{accountId}/wordpress

List the WordPress sites on a web hosting account. Check available first. When it is false, sites is empty and reason says why. An empty list then does not mean the account has no WordPress. A site installed by hand is listed only after GET /api/v2/shared-hosting/{accountId}/wordpress/actions/scan. Each site’s id is what the other WordPress calls take. The list is not paged.

Authentication: An API key with the scopes read:hosting and console:services. About keys and scopes

Request

Path parameters

accountIdstringrequired
The web hosting account ID (acct_…).

Example

GET /api/v2/shared-hosting/{accountId}/wordpress
curl "https://cloud.hostup.se/api/v2/shared-hosting/acct_01hxa3b4c5d6e7f8g9h0j1k2m3/wordpress" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 The account’s WordPress sites.

Response 200
{
"sites": [
{
"id": "wp_01hxa3b4c5d6e7f8g9h0j1k2m3",
"url": "https://example.com",
"path": "/home/abcde/public_html",
"domain": "example.com",
"version": "6.5.5",
"siteName": "Example Store",
"database": "abcde_wp_example",
"adminUsername": "admin",
"installedAt": "2026-04-27T12:00:00.000Z"
}
],
"available": true,
"reason": null
}
Response fields
sitesarray of object
The WordPress sites.
idstring
The WordPress site ID (wp_…).
urlstring
The site’s address.
pathstring
The folder the site is installed in, on the server.
domainstring
The domain the site is on.
versionstring
The WordPress version.
siteNamestring
The site title.
databasestring
The name of the site’s database.
adminUsernamestring or null
The admin username set at install. Null when unknown.
installedAtstring or null
When the site was installed. Null when unknown.
availableboolean
True when the list was read.
reasonstring or null
Why the list could not be read. Null when available is true.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller.
409Conflict. code is account_suspended, account_not_eligible_cpanel.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.
502Upstream failure. A dependent provider request failed; the Problem Details code is upstream_failed. Retry later or contact support if the issue persists.