Retrieves the status of a backup of a WordPress installation

GET

/installs/{install_id}/backups/{backup_id}

curl --request GET \
  --url https://api.wpengineapi.com/v1/installs/example/backups/example \
  --header 'Authorization: Basic <credentials>'

Retrieves the status of a backup of a WordPress installation. Possible statuses include

• requested
• in_progress
• completed
• aborted initiated has been deprecated for in_progress.

Authorizations

• basicAuth

Parameters

Path Parameters

install_id

required

string format: uuid

ID of install

backup_id

required

string format: uuid

ID of backup

Responses

200

A backup

Media type application/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

create_time

Timestamp when the backup was created

string format: date-time

complete_time

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

string format: date-time

wordpress_version

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

string

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 type application/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 Site: Name cannot be empty.",
  "errors": [
    {
      "resource": "Site",
      "field": "name",
      "type": "invalid_value",
      "code": "too_long",
      "message": "Name is too long (maximum is 40 characters)"
    }
  ]
}

401

Authentication Error

Media type application/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"
}

404

Not found

Media type application/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

Media type application/json

503

Service unavailable

Media type application/json