WP Engine Hosting API

Updated date
Updated Jun 29, 2026

Tags:

Key Takeaways

  • WP Engine API enables programmatically interacting with the platform. Users can generate API credentials per account to manage tasks like listing accounts, adding users, and creating backups.

  • Certain tasks like managing SSL and themes cannot be done via WP Engine API. This limitation requires manual intervention for specific account actions.

  • User access in the WP Engine User Portal dictates API call permissions. Understanding roles and permissions is crucial for effective API utilization.

  • Explore API code samples for practical implementation. Developers can refer to code samples for seamless integration and efficient API usage.

The WP Engine API allows you the ability to interact with our platform programmatically. API credentials need to be generated on a per-user basis. In this article, we will show you how to enable the WP Engine API on your account and how to generate your own API credentials.

To enable the API for your account, you must be an account Owner. For more information on User Portal roles, check out this guide.

  1. Log in to the User Portal
  2. Expand Users in the lefthand menu
  3. Select API Access
  4. Locate the account name you’d like to enable API access for
  5. Toggle the button to the ON position next to the account name
  6. Click the Generate Credentials button at the top right
    • This will generate the user’s credential required to connect to WP Engine’s API, across all accounts that have API access enabled and they are authorized to access.
    • Copy the username and password to a safe place.
Screenshot of the API Access page in the WP Engine User Portal

Finally, go to https://developers.wpengine.com/docs/managed-hosting-platform/api to learn how to authenticate with the API and learn more about the endpoints available.

Information

Note

Users can only make API calls to environments they have access to in the User Portal. Review User Portal roles and permissions.

The WP Engine API allows you to perform basic account management tasks.

The terms install and environment are interchangeable in the below context.

  • List your WP Engine accounts
  • List account users
  • Add account user
  • Delete account user
  • Update account user
    • User role in the WP Engine User Portal
    • Install IDs that a user can access for Partial users
  • List your sites
  • Add site
  • Rename site
  • Delete site
  • List your installs
  • Add environment
  • Delete environment
  • Add domain(s)
  • Delete domain
  • Set domain as primary
  • Check domain status
  • Create backup
  • Purge cache
  • List your SSH keys
  • Add SSH key
  • Delete SSH key

For full documentation including code samples and our Quick Start guide, please visit:

Tags:

You may also like