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

The Site API from WP Engine — 2 operation(s) for site.

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

This API exposes 5 operations across 2 paths, and defines 11 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.

5 operations 2 paths 11 schemas 1 DELETE2 GET1 PATCH1 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 Site 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 5

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

Site 5
GET
/sites
List your sites
listSites 4 params → 200400401429503
POST
/sites
Create a new site
createSite 2 params → 201400401403429503
GET
/sites/{site_id}
Get a site by ID
getSite 2 params → 200401403404429503
PATCH
/sites/{site_id}
Change a site name
updateSite 3 params → 200400401403404429503
DELETE
/sites/{site_id}
Delete a site
deleteSite 2 params → 204400401403404429503

Schemas 11

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

NotFoundErrorResponse
object
2 properties 1 required
PreviousPage
string
Path to the previous page of results
ResourceError
object
5 properties 5 required
NextPage
string
Path to the next page of results
TooManyRequestsOperation
Too many requests
BadRequestErrorResponse
object
3 properties 1 required
Site
object
9 properties 3 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-site-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 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 Reports API
WP Engine Site Transfer API
WP Engine SSH Key API