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

The Cache API from WP Engine — 1 operation(s) for cache.

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

This API exposes 1 operation across 1 path, and defines 6 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 6 schemas 1 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 Cache 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 POST. Each is listed below with its method, path, parameters, and response codes.

Cache 1
POST
/installs/{install_id}/purge_cache
Purge an install's cache
purgeCache 3 params → 202400401403404429503

Schemas 6

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

NotFoundErrorResponse
object
2 properties 1 required
BadRequestErrorResponse
object
3 properties 1 required
ResourceError
object
5 properties 5 required
ServiceUnavailableOperation
Service unavailable
ForbiddenErrorResponse
object
2 properties 1 required
AuthenticationErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wpengine-cache-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 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