Skip to navigation
API Referencewordpress

Get WordPress instance for the authenticated account

Returns the active WordPress instance for the account. Returns 404 if the account has no WordPress instance.

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Response

WordPress instance details
idstringformat: "uuid"
Unique identifier for the WordPress instance.
usernamestring
WordPress username on the hosting platform.
namestring
Display name for the WordPress instance.
packageLabelstring
Label of the package currently applied to the instance.
packageDisplayNamestring
Display name of the package currently applied to the instance.
rateMonthlystring
Monthly billing rate for the current package, in US dollars.
createdAtdatetime
When the WordPress instance was provisioned.
readyboolean
Whether the WordPress instance is fully provisioned and ready to use.
statusenum

State of the instance. provisioning while the site is being set up, active once it is ready, failed if it could not be created.

Allowed values:
deletedAtdatetime or nullOptional
When the WordPress instance was deleted. Omitted if still active.
failureReasonstring or nullOptional

Why the instance could not be created. Present only when status is failed.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error