Skip to content

List WordPress sites on several accounts

POST /api/v2/shared-hosting/wordpress/batch

Lists the WordPress sites on up to 50 web hosting accounts in one call. For one account, use GET /api/v2/shared-hosting/{accountId}/wordpress. IDs that do not exist or are not on your account are left out of results. An empty accountIds returns an empty results list.

available says whether WordPress management works on the account. reason says why not. An account whose sites could not be read in time comes back with available: false and a reason that asks you to try again.

The call can also start a background search for WordPress sites that were not installed through Hostup. A finished search is not repeated for 24 hours. Sites it finds are added to WordPress management. While the search runs, refreshPending is true. Read the account again shortly to see what it finds.

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

Request

Body

accountIdsarray of stringrequired
Web hosting account IDs (acct_…), at most 50.

Example

POST /api/v2/shared-hosting/wordpress/batch
curl -X POST "https://cloud.hostup.se/api/v2/shared-hosting/wordpress/batch" \
-H "Authorization: Bearer $HOSTUP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountIds": [
"acct_01hxa3b4c5d6e7f8g9h0j1k2m3"
]
}'

Responses

200 WordPress sites per account.

Response 200
{
"results": [
{
"id": "acct_01hxa3b4c5d6e7f8g9h0j1k2m3",
"available": true,
"reason": null,
"installations": [
{
"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"
}
],
"refreshPending": false
}
]
}
Response fields
resultsarray of object
idstring
The web hosting account ID (acct_…).
availableboolean
Whether WordPress management works on this account. false when the account is not active, is not on cPanel or its sites could not be read in time.
reasonstring or null
Why available is false. null when available is true.
installationsarray of object
WordPress sites on the account. Empty when there are none or when available is false.
idstring
The WordPress site ID (wp_…).
urlstring
Address of the site.
pathstring
Folder of the site on the account.
domainstring
Domain the site runs on.
versionstring
WordPress version.
siteNamestring
Site title. Falls back to the site address without www. when the site has no title.
databasestring
Name of the site’s database.
adminUsernamestring or null
WordPress admin username, when known.
installedAtstring or null
When the site was installed.
refreshPendingboolean
true while a background search for more WordPress sites runs on this account. Read the account again shortly to see what it finds.

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.
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.