Skip to content
WP Engine |Hosting Platform API

Get a specific domain for an install

GET
/installs/{install_id}/domains/{domain_id}

Returns specific domain for an install

install_id
required
string format: uuid

ID of install

domain_id
required
string format: uuid

ID of domain

Success

object
name
required
string
Example
torquemag.io
duplicate
required
boolean
Example
true
primary
required
boolean
Example
true
id
required
string
Example
e41fa98f-ea80-4654-b229-a9b765d0863a
network_type

The WP Engine network type configured for the domain. Possible values are ‘AN’ (Advanced Network) ‘GES’ (Global Edge Security) and ‘LEGACY’.

string
Example
AN
network_details

Details about the network configuration for the domain.

object
dns_config_info

DNS configuration information for the domain.

object
cname

The CNAME value to use to configure a DNS CNAME record for the domain.

string
Example
wp.wpenginepowered.com
a_records

IP addresses that can be used to configure a DNS A record for the domain.

Array<string>
Example
[
"127.0.0.1"
]
network_info
object
status

The status of the network configuration for the domain.

string
Example
ACTIVE
ssl

SSL configuration status

object
status
string
Example
active
redirects_to
Array<object>
object
id
string format: uuid
Example
e41fa98f-ea80-4006-b229-a9b765d0863a
name
string
Example
redirect.com
secure_all_urls
required
boolean

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 authorized

object
message
required

A message regarding the error that occurred on the server

string
Example
You don't have permission to perform that action
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