Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WP Engine Backup API

The Backup API from WP Engine — 3 operation(s) for backup.

WP Engine Backup API is one of 17 APIs that WP Engine publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Backup. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 3 paths, and defines 13 schemas. It is described by OpenAPI 2.0, at version 1.17.0.

Requests are made against the base URL https://api.wpengineapi.com/v1.

4 operations 3 paths 13 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.17.0
Base URL
https://api.wpengineapi.com/v1
Authentication
basic
Terms of Service
Resource Areas
1

Authentication & Security 1

WP Engine Backup API declares 1 security scheme for authenticating requests. It defines a basic scheme (basicAuth).

  • basicAuth — API username and password from Portal's API Access page: https://my.wpengine.com/apiaccess

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Backup 4
GET
/installs/{install_id}/backups
List backups for a WordPress installation
listBackups 4 params → 200400401403404429502503
POST
/installs/{install_id}/backups
Requests a new backup of a WordPress installation
createBackup 3 params → 202400401403404429503
GET
/installs/{install_id}/backups/{backup_id}
Retrieves the status of a backup of a WordPress installation
showBackup 3 params → 200400401404429503
POST
/installs/{install_id}/backups/{backup_id}/restore
Restores a WordPress installation from a backup
restoreBackup 4 params → 202400401403404429500502

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Backup (6 properties), ResourceError (5 properties), BadRequestErrorResponse (3 properties), ForbiddenErrorResponse (2 properties). Each schema is shown below with its type and property counts.

InternalServerErrorResponse
object
1 property 1 required
NotFoundErrorResponse
object
2 properties 1 required
Backup
object
6 properties 2 required
PreviousPage
string
Path to the previous page of results
NextPage
string
Path to the next page of results
TooManyRequestsOperation
Too many requests
BadRequestErrorResponse
object
3 properties 1 required
ResourceError
object
5 properties 5 required
ServiceUnavailableOperation
Service unavailable
BadGatewayOperation
An invalid response was received from an upstream server
ResultsCount
integer
The total number of results
ForbiddenErrorResponse
object
2 properties 1 required
AuthenticationErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wpengine-backup-api-openapi.yml Raw ↑

Other APIs WP Engine publishes across the network.

WP Engine Account API
WP Engine Account User API
WP Engine Archive API
WP Engine Cache API
WP Engine Certificates API
WP Engine Domain API
WP Engine Install API
WP Engine Offload Settings API
WP Engine Site API
WP Engine Site Reports API
WP Engine Site Transfer API
WP Engine SSH Key API