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

The Usage API from WP Engine — 6 operation(s) for usage.

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

This API exposes 6 operations across 6 paths, and defines 22 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.

6 operations 6 paths 22 schemas 4 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 Usage 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 6

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

Usage 6
GET
/accounts/{account_id}/usage
Get account usage metrics
getAccountUsageMetrics 6 params → 200400401403404429default
POST
/accounts/{account_id}/usage/refresh_disk_usage
Refresh Disk Usage for all installs associated with account
2 params → 200400401403404429500502
GET
/accounts/{account_id}/usage/summary
Get account level usage summary
getAccountUsageSummary 4 params → 200400401403404429502503
GET
/accounts/{account_id}/usage/insights
Get account usage insights
getAccountUsageInsights 4 params → 200400401403404429502503
GET
/installs/{install_id}/usage
Get a list of daily usage metrics
getInstallUsageMetrics 4 params → 200400404default
POST
/installs/{install_id}/usage/refresh_disk_usage
Refresh disk usage for the given WordPress site environment
refreshEnvironmentDiskUsage 2 params → 200400401403404429500502

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are DailyUsageMetrics (14 properties), UsageMetricsRollup (8 properties), AccountUsageInsights (8 properties), AccountUsageMetricsResponse (6 properties). Each schema is shown below with its type and property counts.

InternalServerErrorResponse
object
1 property 1 required
NotFoundErrorResponse
object
2 properties 1 required
UsageMetricsRollup
object
A rollup of usage metrics.
8 properties
AccountUsageInsights
object
Comprehensive account usage insights broken down by environment types and site types
8 properties
LatestMetricValue
object
The latest information.
2 properties
ResourceError
object
5 properties 5 required
ServiceUnavailableOperation
Service unavailable
DailyUsageMetrics
object
Usage metrics collected over the period of one day. In JSON format, the DailyUsageMetrics int64 values are encoded as a string rather than a number, following…
14 properties
UsageMetricBreakdown
object
Usage metric with breakdown by environment and site types
3 properties
DailyUsageMetricsTrafficMetricsSource
string
The source of the traffic metrics. - TRAFFICMETRICSSOURCEUNSPECIFIED: The source of the traffic metrics is unknown. - ONHOST: The traffic metrics is sourced fr…
TooManyRequestsOperation
Too many requests
InstallDailyUsageMetricsSeries
object
A daily usage metrics series.
4 properties
EnvironmentTypeBreakdown
object
Breakdown of usage by environment type
3 properties
EnvironmentMetrics
object
4 properties
UsageErrorResponse
object
1 property 1 required
BadRequestErrorResponse
object
3 properties 1 required
AccountUsageMetricsResponse
object
6 properties
BadGatewayOperation
An invalid response was received from an upstream server
SiteTypeBreakdown
object
Breakdown of usage by site type
3 properties
UsageRollup
object
A metric rollup.
3 properties
ForbiddenErrorResponse
object
2 properties 1 required
AuthenticationErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wpengine-usage-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 API
WP Engine Site Reports API
WP Engine Site Transfer API