Create a backup

POST

/installs/{install_id}/backups

curl --request POST \
  --url https://api.wpengineapi.com/v1/installs/294deacc-d8b8-4005-82c4-0727ba8ddde0/backups \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "Taking a backup of torquemag before I start developing new features for it", "notification_emails": [ "myself@torquemag.com", "other_person_interested_in_backup@torquemag.com" ] }'

Requests a new backup of the install. Returns the Backup object, and you can check its progress by retrieving it.

Limitations & Warnings

• Asynchronous: the backup isn’t complete when the response is returned. The addresses in notification_emails receive an email once it has completed.

Authorizations

• basicAuth

Parameters

Path Parameters

install_id

required

string format: uuid

ID of install

Example

294deacc-d8b8-4005-82c4-0727ba8ddde0

Request Body^required

Properties

• description - required - A description of this backup.
• notification_emails - required - The email address(es) that will receive an email once the backup has completed.

Media typeapplication/json

object

description

required

A description of this backup.

string

notification_emails

required

The email address(es) that will receive an email once the backup has completed.

Array<string>

Example

{
  "description": "Taking a backup of torquemag before I start developing new features for it",
  "notification_emails": [
    "myself@torquemag.com",
    "other_person_interested_in_backup@torquemag.com"
  ]
}

Responses

202

Returns the created Backup object.

Media typeapplication/json

object

id

required

The unique identifier of the backup

string format: uuid

status

required

State of the backup.

string

Allowed values: requested in_progress completed aborted

description

Human-readable description provided when the backup was requested

string

nullable

create_time

Timestamp when the backup was created

string format: date-time

nullable

complete_time

Timestamp when the backup completed. null while the backup is still in progress.

string format: date-time

nullable

wordpress_version

WordPress version of the install at the time the backup was taken

string

nullable

Example

{
  "id": "e41fa98f-ea80-4654-b229-a9b765d0863a",
  "status": "requested",
  "description": "Pre-deploy snapshot",
  "create_time": "2024-01-15T10:00:00Z",
  "complete_time": "2024-01-15T10:30:00Z",
  "wordpress_version": "6.4.2"
}

400

Bad Request

Media typeapplication/json

object

message

required

A message regarding the error that occurred on the server

string

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

field

required

(Optional) The specific field associated with the error

string

type

required

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

string

code

required

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

string

message

required

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

string

Example

{
  "message": "Invalid request.",
  "errors": [
    {
      "resource": "Resource",
      "field": "field_name",
      "type": "invalid_value",
      "code": "invalid",
      "message": "The value is invalid."
    }
  ]
}

401

Authentication Error

Media typeapplication/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

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

string

Example

{
  "message": "Bad Credentials"
}

403

Not authorized

Media typeapplication/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

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

string

Example

{
  "message": "You don't have permission to perform that action"
}

404

Not found

Media typeapplication/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

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

string

Example

{
  "message": "Not Found"
}

429

Too many requests

500

Internal Server Error

Media typeapplication/json

object

message

required

A message regarding the error that occurred on the server

string

Example

{
  "message": "An unexpected error occurred, please try again in a few minutes"
}

502

An invalid response was received from an upstream server

503

Service unavailable