Get the domains for an install by install id

GET

/installs/{install_id}/domains

Returns domains for a specific install

Authorizations

• basicAuth

Parameters

Path Parameters

install_id

required

string format: uuid

ID of install

Query Parameters

limit

integer

default: 100 <= 100

(Optional) The number of records to return

offset

integer

0

(Optional) The first record of the result set to be retrieved

Responses

200

List of domains for install

object

previous

Path to the previous page of results

string

Example

https://api.wpengineapi.com/v1/example-endpoint?limit=100&offset=0

next

Path to the next page of results

string

Example

https://api.wpengineapi.com/v1/example-endpoint?limit=100&offset=200

count

The total number of results

integer

Example

225

results

Array<object>

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

401

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

403

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

404

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

429

Too many requests

503

Service unavailable