{"id":42365,"date":"2018-09-19T10:27:54","date_gmt":"2018-09-19T15:27:54","guid":{"rendered":"https:\/\/wpengine.com\/?post_type=support&#038;p=42365"},"modified":"2026-03-25T10:05:33","modified_gmt":"2026-03-25T16:05:33","slug":"enabling-wp-engine-api","status":"publish","type":"support","link":"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/","title":{"rendered":"WP Engine Customer API"},"content":{"rendered":"<p>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.<\/p>\n\n\n\n\n\n<hr class=\"wp-block-separator has-css-opacity\">\n\n\n\n<h2 class=\"wp-block-heading\">Enable WPE API<\/h2>\n\n\n\n<p>To enable the API for your account, you must be an account <strong>Owner<\/strong>. For more information on User Portal roles, <a href=\"https:\/\/wpengine.com\/support\/users\/#roles\">check out this guide<\/a>.<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Log in to the <a href=\"https:\/\/my.wpengine.com\">User Portal<\/a><\/li>\n\n\n\n<li>Expand <strong>Users<\/strong> in the lefthand menu<\/li>\n\n\n\n<li>Select <strong>API Access<\/strong>\n<ul class=\"wp-block-list\">\n<li>You can visit this page directly at: <a href=\"https:\/\/my.wpengine.com\/profile\/api_access\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/my.wpengine.com\/profile\/api_access<\/a><\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>Locate the <strong>account name<\/strong> you\u2019d like to enable API access for<\/li>\n\n\n\n<li>Toggle the button to the ON position next to the account name<\/li>\n\n\n\n<li>Click the <strong>Generate Credentials<\/strong> button at the top right\n<ul class=\"wp-block-list\">\n<li>This will generate the user\u2019s credential required to connect to WP Engine\u2019s API, across all accounts that have API access enabled and they are authorized to access.<\/li>\n\n\n\n<li>Copy the username and password to a safe place.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n<ol start=\"9\" class=\"wp-block-list\">\n<li><\/li>\n<\/ol>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"729\" src=\"https:\/\/wpengine.com\/support\/wp-content\/uploads\/2024\/07\/generate-api-credentials-1024x729.png\" alt=\"Screenshot of the API Access page in the WP Engine User Portal \" class=\"wp-image-125406\" srcset=\"https:\/\/wpengine.com\/support\/wp-content\/uploads\/2024\/07\/generate-api-credentials-1024x729.png 1024w, https:\/\/wpengine.com\/support\/wp-content\/uploads\/2024\/07\/generate-api-credentials-300x213.png 300w, https:\/\/wpengine.com\/support\/wp-content\/uploads\/2024\/07\/generate-api-credentials-768x546.png 768w, https:\/\/wpengine.com\/support\/wp-content\/uploads\/2024\/07\/generate-api-credentials-1536x1093.png 1536w, https:\/\/wpengine.com\/support\/wp-content\/uploads\/2024\/07\/generate-api-credentials-1500x1067.png 1500w, https:\/\/wpengine.com\/support\/wp-content\/uploads\/2024\/07\/generate-api-credentials.png 1879w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\"><\/figure>\n\n\n\n<p>Finally, go to <a href=\"https:\/\/developers.wpengine.com\/docs\/managed-hosting-platform\/api\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/developers.wpengine.com\/docs\/managed-hosting-platform\/api<\/a> to learn how to authenticate with the API and learn more about the endpoints available.<\/p>\n\n\n\n<div style=\"color:#32373c;background-color:#00d1b2\" class=\"wp-block-genesis-blocks-gb-notice gb-font-size-18 gb-block-notice\" data-id=\"10de4b\"><div class=\"gb-notice-title\" style=\"color:#fff\"><p>NOTE<\/p><\/div><div class=\"gb-notice-text\" style=\"border-color:#00d1b2\">\n<p>Users can only make API calls to environments they have access to in the User Portal. <a href=\"https:\/\/wpengine.com\/support\/users\/\">Review User Portal roles and permissions.<\/a><\/p>\n<\/div><\/div>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\">\n\n\n\n<h2 class=\"wp-block-heading\">Example tasks that can be done with the WP Engine API<\/h2>\n\n\n\n<p>The WP Engine API allows you to perform basic account management tasks.<\/p>\n\n\n\n<p>The terms <strong>install <\/strong>and <strong>environment <\/strong>are interchangeable in the below context.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>List your WP Engine accounts<\/li>\n\n\n\n<li>List account users<\/li>\n\n\n\n<li>Add account user<\/li>\n\n\n\n<li>Delete account user<\/li>\n\n\n\n<li>Update account user\n<ul class=\"wp-block-list\">\n<li>User role in the WP Engine User Portal<\/li>\n\n\n\n<li>Install IDs that a user can access for <strong>Partial <\/strong>users<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>List your sites<\/li>\n\n\n\n<li>Add site<\/li>\n\n\n\n<li>Rename site<\/li>\n\n\n\n<li>Delete site<\/li>\n\n\n\n<li>List your installs<\/li>\n\n\n\n<li>Add environment<\/li>\n\n\n\n<li>Delete environment<\/li>\n\n\n\n<li>Add domain(s)<\/li>\n\n\n\n<li>Delete domain<\/li>\n\n\n\n<li>Set domain as primary<\/li>\n\n\n\n<li>Check domain status<\/li>\n\n\n\n<li>Create backup<\/li>\n\n\n\n<li>Purge cache<\/li>\n\n\n\n<li>List your SSH keys<\/li>\n\n\n\n<li>Add SSH key<\/li>\n\n\n\n<li>Delete SSH key<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\">\n\n\n\n<h2 class=\"wp-block-heading\">Example tasks that can NOT be done with the WP Engine API<\/h2>\n\n\n\n<p>The following example tasks can <strong>not<\/strong> currently be performed with the WP Engine API.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Copy environment<\/li>\n\n\n\n<li>Transfer environment<\/li>\n\n\n\n<li>Restore backup<\/li>\n\n\n\n<li>Manage SSL<\/li>\n\n\n\n<li>Manage SFTP credentials<\/li>\n\n\n\n<li>Switch network<\/li>\n\n\n\n<li>Manage Redirect Rules<\/li>\n\n\n\n<li>Manage Web Rules<\/li>\n\n\n\n<li>View logs<\/li>\n\n\n\n<li>Manage Git users<\/li>\n\n\n\n<li>Migrate a website<\/li>\n\n\n\n<li>Manage cache exclusions<\/li>\n\n\n\n<li>Manage password protection<\/li>\n\n\n\n<li>Enable\/disable multisite<\/li>\n\n\n\n<li>Enable\/disable \u201credirect bots\u201d setting<\/li>\n\n\n\n<li>Enable\/disable \u201cread only\u201d setting<\/li>\n\n\n\n<li>Enable\/disable \u201calternate cron\u201d setting<\/li>\n\n\n\n<li>Reset file permissions<\/li>\n\n\n\n<li>Manage themes or plugins<\/li>\n\n\n\n<li>Manage product extensions or their settings<\/li>\n\n\n\n<li>Manage Headless (Atlas) Sites\n<ul class=\"wp-block-list\">\n<li>See instead: <a href=\"https:\/\/developers.wpengine.com\/docs\/headless-platform\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/developers.wpengine.com\/docs\/headless-platform<\/a><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\">\n\n\n\n<h2 class=\"wp-block-heading\">Further Reading<\/h2>\n\n\n\n<p>For API code samples, see: <br><a href=\"https:\/\/developers.wpengine.com\/docs\/managed-hosting-platform\/api\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/developers.wpengine.com\/docs\/managed-hosting-platform\/api<\/a><\/p>\n\n\n\n<hr class=\"wp-block-separator has-css-opacity\">\n\n\n\n<p><strong>NEXT STEP: <a href=\"https:\/\/wpengine.com\/support\/local\/\">Use the WPE API to connect with <em>Local<\/em><\/a><\/strong><\/p>","protected":false},"excerpt":{"rendered":"<p>The WP Engine API allows you to interact with our platform programmatically. Learn how to enable the WP Engine API and generate credentials.<\/p>\n","protected":false},"featured_media":126216,"template":"","meta":{"_acf_changed":false,"mediapress_authors_byline":[],"mediapress_draft_name":"","_mediapress_is_draft_copy":false},"support-categories":[14,3,6],"support-tag":[133],"mediapress_author":[],"class_list":["post-42365","support","type-support","status-publish","has-post-thumbnail","hentry","support-categories-account","support-categories-development","support-categories-platform","support-tag-api"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.6 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>WP Engine Customer API - Support Center<\/title>\n<meta name=\"description\" content=\"The WP Engine API allows you to interact with our platform programmatically. Learn how to enable the WP Engine API and generate credentials.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"WP Engine Customer API - Support Center\" \/>\n<meta property=\"og:description\" content=\"The WP Engine API allows you to interact with our platform programmatically. Learn how to enable the WP Engine API and generate credentials.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/\" \/>\n<meta property=\"og:site_name\" content=\"Support Center\" \/>\n<meta property=\"article:modified_time\" content=\"2026-03-25T16:05:33+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/wpengine.com\/support\/wp-content\/uploads\/2019\/12\/wp-engine-featured-image.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1200\" \/>\n\t<meta property=\"og:image:height\" content=\"630\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/wpengine.com\\\/support\\\/enabling-wp-engine-api\\\/\",\"url\":\"https:\\\/\\\/wpengine.com\\\/support\\\/enabling-wp-engine-api\\\/\",\"name\":\"WP Engine Customer API - Support Center\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/wpengine.com\\\/support\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/wpengine.com\\\/support\\\/enabling-wp-engine-api\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/wpengine.com\\\/support\\\/enabling-wp-engine-api\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/wpengine.com\\\/support\\\/wp-content\\\/uploads\\\/2019\\\/12\\\/wp-engine-featured-image.png\",\"datePublished\":\"2018-09-19T15:27:54+00:00\",\"dateModified\":\"2026-03-25T16:05:33+00:00\",\"description\":\"The WP Engine API allows you to interact with our platform programmatically. Learn how to enable the WP Engine API and generate credentials.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/wpengine.com\\\/support\\\/enabling-wp-engine-api\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/wpengine.com\\\/support\\\/enabling-wp-engine-api\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/wpengine.com\\\/support\\\/enabling-wp-engine-api\\\/#primaryimage\",\"url\":\"https:\\\/\\\/wpengine.com\\\/support\\\/wp-content\\\/uploads\\\/2019\\\/12\\\/wp-engine-featured-image.png\",\"contentUrl\":\"https:\\\/\\\/wpengine.com\\\/support\\\/wp-content\\\/uploads\\\/2019\\\/12\\\/wp-engine-featured-image.png\",\"width\":1200,\"height\":630,\"caption\":\"WP Engine\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/wpengine.com\\\/support\\\/enabling-wp-engine-api\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/wpengine.com\\\/support\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Support Posts\",\"item\":\"https:\\\/\\\/wpengine.com\\\/support\\\/support\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"WP Engine Customer API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/wpengine.com\\\/support\\\/#website\",\"url\":\"https:\\\/\\\/wpengine.com\\\/support\\\/\",\"name\":\"Support Center\",\"description\":\"WP Engine&#039;s Support Center\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/wpengine.com\\\/support\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"WP Engine Customer API - Support Center","description":"The WP Engine API allows you to interact with our platform programmatically. Learn how to enable the WP Engine API and generate credentials.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/","og_locale":"en_US","og_type":"article","og_title":"WP Engine Customer API - Support Center","og_description":"The WP Engine API allows you to interact with our platform programmatically. Learn how to enable the WP Engine API and generate credentials.","og_url":"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/","og_site_name":"Support Center","article_modified_time":"2026-03-25T16:05:33+00:00","og_image":[{"width":1200,"height":630,"url":"https:\/\/wpengine.com\/support\/wp-content\/uploads\/2019\/12\/wp-engine-featured-image.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/","url":"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/","name":"WP Engine Customer API - Support Center","isPartOf":{"@id":"https:\/\/wpengine.com\/support\/#website"},"primaryImageOfPage":{"@id":"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/#primaryimage"},"image":{"@id":"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/#primaryimage"},"thumbnailUrl":"https:\/\/wpengine.com\/support\/wp-content\/uploads\/2019\/12\/wp-engine-featured-image.png","datePublished":"2018-09-19T15:27:54+00:00","dateModified":"2026-03-25T16:05:33+00:00","description":"The WP Engine API allows you to interact with our platform programmatically. Learn how to enable the WP Engine API and generate credentials.","breadcrumb":{"@id":"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/#primaryimage","url":"https:\/\/wpengine.com\/support\/wp-content\/uploads\/2019\/12\/wp-engine-featured-image.png","contentUrl":"https:\/\/wpengine.com\/support\/wp-content\/uploads\/2019\/12\/wp-engine-featured-image.png","width":1200,"height":630,"caption":"WP Engine"},{"@type":"BreadcrumbList","@id":"https:\/\/wpengine.com\/support\/enabling-wp-engine-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/wpengine.com\/support\/"},{"@type":"ListItem","position":2,"name":"Support Posts","item":"https:\/\/wpengine.com\/support\/support\/"},{"@type":"ListItem","position":3,"name":"WP Engine Customer API"}]},{"@type":"WebSite","@id":"https:\/\/wpengine.com\/support\/#website","url":"https:\/\/wpengine.com\/support\/","name":"Support Center","description":"WP Engine&#039;s Support Center","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/wpengine.com\/support\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/wpengine.com\/support\/wp-json\/wp\/v2\/support\/42365","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wpengine.com\/support\/wp-json\/wp\/v2\/support"}],"about":[{"href":"https:\/\/wpengine.com\/support\/wp-json\/wp\/v2\/types\/support"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/wpengine.com\/support\/wp-json\/wp\/v2\/media\/126216"}],"wp:attachment":[{"href":"https:\/\/wpengine.com\/support\/wp-json\/wp\/v2\/media?parent=42365"}],"wp:term":[{"taxonomy":"support-categories","embeddable":true,"href":"https:\/\/wpengine.com\/support\/wp-json\/wp\/v2\/support-categories?post=42365"},{"taxonomy":"support-tag","embeddable":true,"href":"https:\/\/wpengine.com\/support\/wp-json\/wp\/v2\/support-tag?post=42365"},{"taxonomy":"mediapress_author","embeddable":true,"href":"https:\/\/wpengine.com\/support\/wp-json\/wp\/v2\/mediapress_author?post=42365"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}