{"id":3629,"date":"2020-08-29T03:11:12","date_gmt":"2020-08-29T03:11:12","guid":{"rendered":"https:\/\/devel.www.cpanel.net\/?page_id=3629"},"modified":"2020-08-29T04:13:00","modified_gmt":"2020-08-29T04:13:00","slug":"api-1-removal","status":"publish","type":"page","link":"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/","title":{"rendered":"cPanel API 1 Removal and Replacement with UAPI"},"content":{"rendered":"\n<h2 class=\"lead wp-block-heading\">With the release of&nbsp;Version 88,&nbsp;we will start removing cPanel API 1 \nfunctionality, and any custom code or integrations using these calls \nwill no longer work.<\/h2>\n\n\n\n<p class=\"p-3 border bg-white-off mb-4 mt-5\">The cPanel API 1 functions \nare being replaced with UAPI equivalents, and you should update your \ncustom integrations to use the new UAPI functions.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Why<\/h3>\n\n\n\n<p class=\"mb-5\">cPanel &amp; WHM is consolidating old and outdated APIs \ninto one system to simplify&nbsp;the process of integrations. We are porting \ncPanel API 1 functions to UAPI, which will have improved functionality.&nbsp;<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Impact<\/h3>\n\n\n\n<p>cPanel\u2019s API 1 is being removed&nbsp;and custom integrations using \nit&nbsp;will&nbsp;no longer work after Version 86. This will affect any custom \ncode that relies on the old API 1 calls, which could \ninclude&nbsp;integrations,&nbsp;plugins, tools, or products which will break if \nthey are not updated to UAPI.&nbsp;<\/p>\n\n\n\n<p class=\"mb-5\">Server owners should resolve any dependencies on cPanel API 1 before upgrading to Version 88.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Benefits<\/h3>\n\n\n\n<p class=\"mb-5\">The&nbsp;cPanel API 1 system is&nbsp;outdated and&nbsp;inconsistent function to function,&nbsp;so we\u2019ve steadily been adding its functionality to&nbsp;<a href=\"https:\/\/blog.cpanel.com\/uapi-whats-new-in-82\/\">UAPI<\/a>,&nbsp;and\n continuing work on uniting our APIs into one system. This not only \nsimplifies the process of integration but also provides improved \nfunctionality moving forward. UAPI has additional features to help \nmanage data returned from API requests.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"> What can you do?<\/h3>\n\n\n\n<p>Update your custom integrations to use UAPI or cPanel API 2 if a UAPI equivalent is not available. <\/p>\n\n\n\n<p>If you rely on\u00a0plugins that use cPanel API 1, you should contact the  maintainers\u00a0to ensure\u00a0that the plugins\u00a0are updated to use UAPI so that  they will be compatible after\u00a0Version 86.<\/p>\n\n\n\n<p class=\"mb-5\">Since Version 86 is the new long term support tier, you can also switch your release tier to LTS which will allow you to stay on Version 86 for a longer period of time.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Anything else I should know?<\/h3>\n\n\n\n<p>We have added functionality in Version 86 that will detect usage of \nAPI 1 calls and log them on the server. The&nbsp;system administrator will be\n notified that these calls are present as they occur on the server, and \ntherefore&nbsp;will know what needs to be updated.\n\n\n\nIf it isn\u2019t practical to receive notifications because of the amount of your servers you manage, we have added two new <a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/Guide+to+WHM+API+1\">WHM API 1<\/a> calls, <a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/WHM+API+1+Functions+-+get_api_calls\"><code>get_api_calls<\/code><\/a> and <a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/WHM+API+1+Functions+-+get_api_pages\"><code>get_api_pages<\/code><\/a>, that can be integrated into your server management software to monitor cPanel API 1 usage across your fleet.\n\n\n\n<\/p>\n","protected":false},"excerpt":{"rendered":"<p>With the release of&nbsp;Version 88,&nbsp;we will start removing cPanel API 1 functionality, and any custom code or integrations using these calls will no longer work. The cPanel API 1 functions are being replaced with UAPI equivalents, and you should update your custom integrations to use the new UAPI functions. Why cPanel &amp; WHM is consolidating [&hellip;]<\/p>\n","protected":false},"author":9,"featured_media":0,"parent":2617,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"page-templates\/page-upnext-api1.php","meta":{"inline_featured_image":false,"footnotes":""},"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v21.6 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>cPanel API 1 Removal and Replacement with UAPI | cPanel<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"cPanel API 1 Removal and Replacement with UAPI | cPanel\" \/>\n<meta property=\"og:description\" content=\"With the release of&nbsp;Version 88,&nbsp;we will start removing cPanel API 1 functionality, and any custom code or integrations using these calls will no longer work. The cPanel API 1 functions are being replaced with UAPI equivalents, and you should update your custom integrations to use the new UAPI functions. Why cPanel &amp; WHM is consolidating [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/\" \/>\n<meta property=\"og:site_name\" content=\"cPanel\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/cpanel\/\" \/>\n<meta property=\"article:modified_time\" content=\"2020-08-29T04:13:00+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@cPanel\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/\",\"url\":\"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/\",\"name\":\"cPanel API 1 Removal and Replacement with UAPI | cPanel\",\"isPartOf\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/#website\"},\"datePublished\":\"2020-08-29T03:11:12+00:00\",\"dateModified\":\"2020-08-29T04:13:00+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/devel.www.cpanel.net\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Private: Up Next\",\"item\":\"https:\/\/devel.www.cpanel.net\/?page_id=2617\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"cPanel API 1 Removal and Replacement with UAPI\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/devel.www.cpanel.net\/#website\",\"url\":\"https:\/\/devel.www.cpanel.net\/\",\"name\":\"cPanel\",\"description\":\"Hosting Platform of Choices\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/devel.www.cpanel.net\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"cPanel API 1 Removal and Replacement with UAPI | cPanel","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:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/","og_locale":"en_US","og_type":"article","og_title":"cPanel API 1 Removal and Replacement with UAPI | cPanel","og_description":"With the release of&nbsp;Version 88,&nbsp;we will start removing cPanel API 1 functionality, and any custom code or integrations using these calls will no longer work. The cPanel API 1 functions are being replaced with UAPI equivalents, and you should update your custom integrations to use the new UAPI functions. Why cPanel &amp; WHM is consolidating [&hellip;]","og_url":"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/","og_site_name":"cPanel","article_publisher":"https:\/\/www.facebook.com\/cpanel\/","article_modified_time":"2020-08-29T04:13:00+00:00","twitter_card":"summary_large_image","twitter_site":"@cPanel","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/","url":"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/","name":"cPanel API 1 Removal and Replacement with UAPI | cPanel","isPartOf":{"@id":"https:\/\/devel.www.cpanel.net\/#website"},"datePublished":"2020-08-29T03:11:12+00:00","dateModified":"2020-08-29T04:13:00+00:00","breadcrumb":{"@id":"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/devel.www.cpanel.net\/up-next\/api-1-removal\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/devel.www.cpanel.net\/"},{"@type":"ListItem","position":2,"name":"Private: Up Next","item":"https:\/\/devel.www.cpanel.net\/?page_id=2617"},{"@type":"ListItem","position":3,"name":"cPanel API 1 Removal and Replacement with UAPI"}]},{"@type":"WebSite","@id":"https:\/\/devel.www.cpanel.net\/#website","url":"https:\/\/devel.www.cpanel.net\/","name":"cPanel","description":"Hosting Platform of Choices","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/devel.www.cpanel.net\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/pages\/3629"}],"collection":[{"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/users\/9"}],"replies":[{"embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/comments?post=3629"}],"version-history":[{"count":4,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/pages\/3629\/revisions"}],"predecessor-version":[{"id":3757,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/pages\/3629\/revisions\/3757"}],"up":[{"embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/pages\/2617"}],"wp:attachment":[{"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/media?parent=3629"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}