Requests a new backup of a WordPress installation

POST

/installs/{install_id}/backups

Kicks off a backup of a WordPress installation.

Authorizations

• basicAuth

Parameters

Path Parameters

install_id

required

string format: uuid

ID of install

Request Body

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.

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

Accepted

object

id

string

Example

28c78b6d-c2da-4f09-85f5-1ad588089b2d

status

string

Example

requested

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

503

Service unavailable