Skip to content
WP Engine
Documentation
Search
Ctrl
K
Cancel
GitHub
YouTube
X
Select theme
Dark
Light
Auto
Headless
Platforms
Managed Hosting
Headless
Newsroom
Product Extensions
AI Toolkit
NitroPack
Plugins
Advanced Custom Fields
WP Migrate
WP Offload Media
WP Offload SES
Better Search Replace
Tools
Faust.js
Genesis
Local
Overview
Getting Started
,
Create an App
Deploy from Existing Repo
Deploy from Blueprint
Add an Environment to App
Updating a Headless Environment
Local App Development
Platform Guides
,
Customizing Builds
Troubleshooting Builds
Runtime logs
Environment Variables
Domain Mapping
Site Transfer
Build Notifications
Preview Environments
Automatic Builds
Redeploy Previous Version
Access Logs
Password Protection
Webhooks
Post and Page Previews
WPGraphQL Smart Cache Optimization
Grouping Requests
Support
Framework Guides
,
Next.js
,
Next.js guide
Incremental Static Regeneration
Astro
Gatsby
Nuxt.js
Remix
SvelteKit
Qwik
SPA & Static
Additional Guides
,
Query Optimization
Cache-Control Headers
Migrating Node.js Apps
Request Headers
Setting up Health Checks
Edge Cache Purge Library
Networking
API documentation
,
API authentication
Create app through direct upload
Endpoint Reference
,
Overview
Application
,
List all Headless Platform applications associated with your account
Create a new Headless Platform application on your account
Get the detailed information about your Headless Platform application
Delete a Headless Platform application from your account
Environment
,
Direct upload to Headless Platform - upload .zip file with new version of your application code
List all environments under your Headless Platform application
Create a new environment under your Headless Platform application
Get the detailed information about an environment under your Headless Platform application
Delete an environment
Update the environment.
CLI Reference
,
wpe
wpe apps
,
create
delete
get
init
list
rebuild
update
wpe auth
,
login
logout
wpe builds
,
get
list
wpe context
,
get
set
wpe envs
,
delete
purge
rebuild
wpe logs
,
get
wpe completion
,
bash
zsh
Portal
Support Center
GitHub
YouTube
X
Select theme
Dark
Light
Auto
Overview
WP Engine Headless Platform API
1.0
Section titled “WP Engine Headless Platform API 1.0”
Information
OpenAPI version:
2.0
Operations
Section titled “ Operations ”
GET
/v1/accounts/{account}/apps
POST
/v1/accounts/{account}/apps
GET
/v1/accounts/{account}/apps/{app}
DELETE
/v1/accounts/{account}/apps/{app}
POST
/fu/v1/accounts/{account}/apps/{app}/environments/{environment}:upload
GET
/v1/accounts/{account}/apps/{app}/environments
POST
/v1/accounts/{account}/apps/{app}/environments
GET
/v1/accounts/{account}/apps/{app}/environments/{environment}
DELETE
/v1/accounts/{account}/apps/{app}/environments/{environment}
PATCH
/v1/accounts/{account}/apps/{app}/environments/{environment}
Authentication
Section titled “ Authentication ”
basicAuth
Section titled “basicAuth ”
Security scheme type:
basic