WP Engine Site API
The Site API from WP Engine — 2 operation(s) for site.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/wpengine-site-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: 'The API described in this document is subject to change.
'
version: 1.17.0
title: WP Engine Hosting Platform Account Site API
termsOfService: https://wpengine.com/legal/terms-of-service/
servers:
- url: https://api.wpengineapi.com/v1
tags:
- name: Site
paths:
/sites:
get:
tags:
- Site
summary: List your sites
description: ''
operationId: listSites
parameters:
- $ref: '#/components/parameters/authorization'
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/account_id'
responses:
'200':
description: List of sites
content:
application/json:
schema:
type: object
properties:
previous:
$ref: '#/components/schemas/PreviousPage'
next:
$ref: '#/components/schemas/NextPage'
count:
$ref: '#/components/schemas/ResultsCount'
results:
type: array
items:
$ref: '#/components/schemas/Site'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestErrorResponse'
'401':
description: Authentication Error
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationErrorResponse'
'429':
$ref: '#/components/schemas/TooManyRequestsOperation'
'503':
$ref: '#/components/schemas/ServiceUnavailableOperation'
security:
- basicAuth: []
x-amazon-apigateway-integration:
uri: https://my.wpengine.com/capi/v1/sites
responses:
'200':
statusCode: '200'
'400':
statusCode: '400'
'401':
statusCode: '401'
'429':
statusCode: '429'
'503':
statusCode: '503'
default:
statusCode: '500'
requestParameters:
integration.request.header.X-Request-ID: context.requestId
integration.request.header.sourceIp: context.identity.sourceIp
integration.request.header.authorization: method.request.header.Authorization
integration.request.querystring.offset: method.request.querystring.offset
integration.request.querystring.limit: method.request.querystring.limit
integration.request.querystring.account_id: method.request.querystring.account_id
passthroughBehavior: when_no_match
httpMethod: GET
type: http
post:
tags:
- Site
summary: Create a new site
description: ''
operationId: createSite
parameters:
- $ref: '#/components/parameters/authorization'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestErrorResponse'
'401':
description: Authentication Error
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationErrorResponse'
'403':
description: Not authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorResponse'
'429':
$ref: '#/components/schemas/TooManyRequestsOperation'
'503':
$ref: '#/components/schemas/ServiceUnavailableOperation'
security:
- basicAuth: []
x-amazon-apigateway-integration:
uri: https://my.wpengine.com/capi/v1/sites
responses:
'201':
statusCode: '201'
'400':
statusCode: '400'
'401':
statusCode: '401'
'403':
statusCode: '403'
'429':
statusCode: '429'
'503':
statusCode: '503'
default:
statusCode: '500'
requestParameters:
integration.request.header.X-Request-ID: context.requestId
integration.request.header.sourceIp: context.identity.sourceIp
integration.request.header.authorization: method.request.header.Authorization
passthroughBehavior: when_no_match
httpMethod: POST
type: http
requestBody:
content:
application/json:
schema:
type: object
required:
- name
- account_id
properties:
name:
type: string
example: Torque Magazine
account_id:
type: string
format: uuid
example: eeda3227-9a39-46ae-9e14-20958bb4e6c9
description: The account ID
description: '##### Properties
* name - **required** - The name of the site
* account_id - **required** - The ID of the account that the site will belong to
'
required: true
/sites/{site_id}:
get:
tags:
- Site
summary: Get a site by ID
description: Returns a single site
operationId: getSite
parameters:
- $ref: '#/components/parameters/authorization'
- name: site_id
in: path
description: The site ID
required: true
x-example: a1b2c3d4-e5f6-41b2-b3d4-e5f6a1b2c3d4
schema:
type: string
format: uuid
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
'401':
description: Authentication Error
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationErrorResponse'
'403':
description: Not authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorResponse'
'429':
$ref: '#/components/schemas/TooManyRequestsOperation'
'503':
$ref: '#/components/schemas/ServiceUnavailableOperation'
security:
- basicAuth: []
x-amazon-apigateway-integration:
uri: https://my.wpengine.com/capi/v1/sites/{site_id}
responses:
'200':
statusCode: '200'
'401':
statusCode: '401'
'403':
statusCode: '403'
'404':
statusCode: '404'
'429':
statusCode: '429'
'503':
statusCode: '503'
default:
statusCode: '500'
requestParameters:
integration.request.header.X-Request-ID: context.requestId
integration.request.header.sourceIp: context.identity.sourceIp
integration.request.header.authorization: method.request.header.Authorization
integration.request.path.site_id: method.request.path.site_id
passthroughBehavior: when_no_match
httpMethod: GET
type: http
patch:
tags:
- Site
summary: Change a site name
description: ''
operationId: updateSite
parameters:
- $ref: '#/components/parameters/authorization'
- name: site_id
in: path
description: The ID of the site to change the name of *(For accounts with sites enabled)*
required: true
x-example: 294deacc-d8b8-4005-82c4-0727ba8ddde0
schema:
type: string
format: uuid
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestErrorResponse'
'401':
description: Authentication Error
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationErrorResponse'
'403':
description: Not authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorResponse'
'429':
$ref: '#/components/schemas/TooManyRequestsOperation'
'503':
$ref: '#/components/schemas/ServiceUnavailableOperation'
security:
- basicAuth: []
x-amazon-apigateway-integration:
uri: https://my.wpengine.com/capi/v1/sites/{site_id}
responses:
'200':
statusCode: '200'
'400':
statusCode: '400'
'401':
statusCode: '401'
'403':
statusCode: '403'
'404':
statusCode: '404'
'429':
statusCode: '429'
'503':
statusCode: '503'
default:
statusCode: '500'
requestParameters:
integration.request.header.X-Request-ID: context.requestId
integration.request.header.sourceIp: context.identity.sourceIp
integration.request.header.authorization: method.request.header.Authorization
integration.request.path.site_id: method.request.path.site_id
passthroughBehavior: when_no_match
httpMethod: PATCH
type: http
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The new site name
example: My New Name
description: '##### Properties
* name - The new name for the site
'
required: true
delete:
tags:
- Site
summary: Delete a site
description: This will delete the site and any installs associated with this site. This delete is permanent and there is no confirmation prompt.
operationId: deleteSite
parameters:
- $ref: '#/components/parameters/authorization'
- name: site_id
in: path
description: The ID of the site to delete *(For accounts with sites enabled)*
required: true
x-example: 294deacc-d8b8-4005-82c4-0727ba8ddde0
schema:
type: string
format: uuid
responses:
'204':
description: Deleted
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestErrorResponse'
'401':
description: Authentication Error
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationErrorResponse'
'403':
description: Not authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorResponse'
'429':
$ref: '#/components/schemas/TooManyRequestsOperation'
'503':
$ref: '#/components/schemas/ServiceUnavailableOperation'
security:
- basicAuth: []
x-amazon-apigateway-integration:
uri: https://my.wpengine.com/capi/v1/sites/{site_id}
responses:
'204':
statusCode: '204'
'400':
statusCode: '400'
'401':
statusCode: '401'
'403':
statusCode: '403'
'404':
statusCode: '404'
'429':
statusCode: '429'
'503':
statusCode: '503'
default:
statusCode: '500'
requestParameters:
integration.request.header.X-Request-ID: context.requestId
integration.request.header.sourceIp: context.identity.sourceIp
integration.request.header.authorization: method.request.header.Authorization
integration.request.path.site_id: method.request.path.site_id
passthroughBehavior: when_no_match
httpMethod: DELETE
type: http
components:
parameters:
account_id:
name: account_id
in: query
required: false
description: (Optional) The uuid of an account
x-example: eeda3227-9a39-46ae-9e14-20958bb4e6c9
schema:
type: string
format: uuid
authorization:
name: Authorization
in: header
schema:
type: string
format: uuid
limitParam:
name: limit
in: query
required: false
description: (Optional) The number of records to return
schema:
type: integer
default: 100
maximum: 100
minimum: 0
offsetParam:
name: offset
in: query
required: false
description: (Optional) The first record of the result set to be retrieved
schema:
type: integer
default: 0
minimum: 0
schemas:
NotFoundErrorResponse:
type: object
required:
- message
properties:
message:
type: string
description: A message regarding the error that occurred on the server
example: Not Found
documentation_url:
type: string
description: (Optional) A URL where documentation regarding this specific error can be found
ServiceUnavailableOperation:
description: Service unavailable
PreviousPage:
type:
- string
- 'null'
example: https://api.wpengineapi.com/v1/example-endpoint?limit=100&offset=0
description: Path to the previous page of results
ResourceError:
type: object
required:
- resource
- field
- type
- code
- message
properties:
resource:
type: string
description: The name of the resource that was being processed when the error occurred
example: Site
field:
type: string
description: (Optional) The specific field associated with the error
example: name
type:
type: string
description: (Optional) A type associated with the error. `invalid_value`, `access_error`, `value_unavailable`
example: invalid_value
code:
type: string
description: (Optional) A machine code relating to the error that occurred with the field and resource
example: too_long
message:
type: string
description: (Optional) A human-readable message relating to the error that occurred with the field and resource
example: Name is too long (maximum is 40 characters)
AuthenticationErrorResponse:
type: object
required:
- message
properties:
message:
type: string
description: A message regarding the error that occurred on the server
example: Bad Credentials
documentation_url:
type: string
description: (Optional) A URL where documentation regarding this specific error can be found
ResultsCount:
type: integer
example: 225
description: The total number of results
BadRequestErrorResponse:
type: object
required:
- message
properties:
message:
type: string
description: A message regarding the error that occurred on the server
example: 'Invalid Site: Name cannot be empty.'
documentation_url:
type: string
description: (Optional) A URL where documentation regarding this specific error can be found
errors:
type: array
description: An array of error objects describing specific errors that arose when servicing the request
items:
$ref: '#/components/schemas/ResourceError'
TooManyRequestsOperation:
description: Too many requests
NextPage:
type:
- string
- 'null'
example: https://api.wpengineapi.com/v1/example-endpoint?limit=100&offset=200
description: Path to the next page of results
Site:
type: object
required:
- id
- name
- account
properties:
id:
type: string
format: uuid
example: 28c78b6d-c2da-4f09-85f5-1ad588089b2d
name:
type: string
example: Torque Magazine
account:
type: object
properties:
id:
type: string
description: The account ID
format: uuid
example: eeda3227-9a39-46ae-9e14-20958bb4e6c9
group_name:
type:
- string
- 'null'
example: Overdue
tags:
type: array
items:
type: string
description: Tag name
example:
- tag1
- tag2
- tag3
created_at:
type: string
format: date-time
description: The date and time the site was created in UTC
example: '2025-07-10T09:59:58.684Z'
sandbox:
type: boolean
description: Whether the site is a sandbox site
example: false
transferable:
type: boolean
description: Whether the site is transferable
example: false
installs:
type: array
items:
properties:
id:
type: string
format: uuid
example: 294deacc-d8b8-4005-82c4-0727ba8ddde0
name:
type: string
example: torquemag
environment:
type:
- string
- 'null'
enum:
- production
- staging
- development
- null
cname:
type: string
description: Returns the CNAME of the install
example: mywebsite.wpengine.com
php_version:
type:
- string
- 'null'
description: The PHP version used to run WordPress
example: '7.3'
is_multisite:
type:
- boolean
- 'null'
example: false
ForbiddenErrorResponse:
type: object
required:
- message
properties:
message:
type: string
description: A message regarding the error that occurred on the server
example: You don't have permission to perform that action
documentation_url:
type: string
description: (Optional) A URL where documentation regarding this specific error can be found
securitySchemes:
basicAuth:
type: http
scheme: basic
description: 'API username and password from Portal''s API Access page: https://my.wpengine.com/api_access'