WP Engine Offload Settings API
The Offload Settings API from WP Engine — 2 operation(s) for offload settings.
WP Engine Offload Settings 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 Offload Settings. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 4 operations across 2 paths, and defines 9 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
WP Engine Offload Settings 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 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ResourceError (5 properties), BadRequestErrorResponse (3 properties), NotFoundErrorResponse (2 properties), ForbiddenErrorResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from WP Engine 12
Other APIs WP Engine publishes across the network.