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

The Domain API from WP Engine — 6 operation(s) for domain.

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

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

9 operations 6 paths 17 schemas 1 DELETE3 GET1 PATCH4 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 Domain 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 9

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

Domain 9
GET
/installs/{install_id}/domains
Get the domains for an install by install id
listDomains 4 params → 200401403404429503
POST
/installs/{install_id}/domains
Add a new domain or redirect to an existing install
createDomain 3 params → 201400401403429503
POST
/installs/{install_id}/domains/bulk
Add multiple domains and redirects to an existing install
createBulkDomains 3 params → 201400401403429503
GET
/installs/{install_id}/domains/{domain_id}
Get a specific domain for an install
getDomain 3 params → 200401403404429503
PATCH
/installs/{install_id}/domains/{domain_id}
Update an existing domain for an install
updateDomain 4 params → 200400401403404429503
DELETE
/installs/{install_id}/domains/{domain_id}
Delete a specific domain for an install
deleteDomain 3 params → 204400401403404429503
POST
/installs/{install_id}/domains/{domain_id}/verification
Trigger domain TXT record verification
verifyDomainTxtRecord 3 params → 200400401403404429500503
POST
/installs/{install_id}/domains/{domain_id}/check_status
Submit a status report for a domain
checkStatus 3 params → 202401403404429500503
GET
/installs/{install_id}/domains/check_status/{report_id}
Retrieve a status report for a domain
getDomainReportStatus 3 params → 200401403404429500503

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are DomainStatus (23 properties), Domain (13 properties), DomainOrRedirect (10 properties), DomainStatusReport (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
DomainOrRedirect
object
10 properties 4 required
Domain
object
13 properties 5 required
PreviousPage
string
Path to the previous page of results
ResourceError
object
5 properties 5 required
ServiceUnavailableOperation
Service unavailable
ResultsCount
integer
The total number of results
NextPage
string
Path to the next page of results
DomainStatus
object
23 properties
TooManyRequestsOperation
Too many requests
DomainVerification
object
6 properties
BadRequestErrorResponse
object
3 properties 1 required
DomainReport
object
1 property 1 required
DomainStatusReport
object
6 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-domain-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 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