Copy the full file system and database from one WordPress installation to another

POST

/install_copy

Authorizations

• basicAuth

Request Body

Properties

• source_environment_id - required - The ID of the environment to copy from. Must be on the same account as destination_environment_id
• destination_environment_id - required - The ID of the environment to copy to. The contents of this environment will be overwritten. Must be on the same account as source_environment_id
• notification_emails - optional - An array of email addresses to notify when the copy is complete

object

source_environment_id

required

The ID of the environment to copy from

string format: uuid

Example

8f14e45f-ceea-4b5b-9f6d-8f14e45fceea

destination_environment_id

required

The ID of the environment to copy to

string format: uuid

Example

c9f0f895-fb98-4f3c-9f0f-c9f0f895fb98

notification_emails

An array of email addresses to notify when the copy is complete

Array<string>

Responses

202

Accepted

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

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

Too many requests

500

Internal server error

object

message

required

A message regarding the error that occurred on the server

string

Example

An unexpected error occurred, please try again in a few minutes

502

An invalid response was received from an upstream server

503

Service unavailable