Add a new domain or redirect to an existing install

POST

/installs/{install_id}/domains

Adds a domain or redirect to a specific install and optionally sets it as the primary domain

Authorizations

• basicAuth

Parameters

Path Parameters

install_id

required

string format: uuid

ID of install

Request Body

Properties

• name - required - The name of the new domain
• primary - optional - Sets the domain as the primary domain on the install
• redirect_to - optional - ID of a domain to create a redirect to

object

name

required

string

primary

boolean

redirect_to

string format: uuid

Example

{
  "name": "example.com",
  "primary": true
}

Responses

201

Created

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

400

Bad Request

object

message

required

A message regarding the error that occurred on the server

string

Example

Invalid Site: Name cannot be empty.

documentation_url

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

string

errors

An array of error objects describing specific errors that arose when servicing the request

Array<object>

object

resource

required

The name of the resource that was being processed when the error occurred

string

Example

Site

field

required

(Optional) The specific field associated with the error

string

Example

name

type

required

(Optional) A type associated with the error. invalid_value, access_error, value_unavailable

string

Example

invalid_value

code

required

(Optional) A machine code relating to the error that occurred with the field and resource

string

Example

too_long

message

required

(Optional) A human-readable message relating to the error that occurred with the field and resource

string

Example

Name is too long (maximum is 40 characters)

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

429

Too many requests

503

Service unavailable