Skip to content
WP Engine |Hosting Platform API

Get an install by ID

GET
/installs/{install_id}

Returns a single Install

install_id
required
string format: uuid

ID of install

Success

object
id
required
string format: uuid
Example
294deacc-d8b8-4005-82c4-0727ba8ddde0
name
required
string
/^[a-z][a-z0-9]{2,13}$/
Example
torquemag
account
required
object
id

The account ID

string format: uuid
Example
eeda3227-9a39-46ae-9e14-20958bb4e6c9
php_version
required

The PHP version used to run WordPress (read-only)

string
Example
7.0
status
string
Allowed values: active pending
site
object
id
string format: uuid
Example
28c78b6d-c2da-4f09-85f5-1ad588089b2d
cname

Returns the CNAME of the install

string
Example
mywebsite.wpengine.com
stable_ips

A list of stable IPs bound to the install. This will only apply to some premium/enterprise plans

Array<string>
Example
[
"1.2.3.2",
"1.1.1.2"
]
environment
string
Allowed values: production staging development
primary_domain

The primary domain for the install.

string
Example
mywebsite.wpengine.com
is_multisite
boolean
created_at

The date and time the install was created in UTC.

string format: date-time
Example
2025-06-12T09:56:42.386Z
wp_version

The WordPress version installed on the install. Only returned when requesting an individual install.

string
Example
6.8.1
defer_wordpress_upgrades_until

If set, automatic WordPress core major updates will be deferred until this date. Only returned when requesting an individual install.

string format: date-time
Example
2025-12-31T23:59:59.999Z

Authentication Error

object
message
required

A message regarding the error that occurred on the server

string
Example
Bad Credentials
documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Not found

object
message
required

A message regarding the error that occurred on the server

string
Example
Not Found
documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Too many requests

Service unavailable