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 Archive API

The Archive API from WP Engine — 1 operation(s) for archive.

WP Engine Archive 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 Archive. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 12 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.

1 operations 1 paths 12 schemas 1 GET

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 Archive 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Archive 1
GET
/installs/{install_id}/archives
List archives for a WordPress installation
listArchives 4 params → 200400401403404429500503

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Archive (9 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
PreviousPage
string
Path to the previous page of results
Archive
object
9 properties 3 required
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
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-archive-api-openapi.yml Raw ↑

Other APIs WP Engine publishes across the network.

WP Engine Account API
WP Engine Account User API
WP Engine Backup 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