{"id":53031,"date":"2019-07-11T13:00:39","date_gmt":"2019-07-11T18:00:39","guid":{"rendered":"https:\/\/blog.cpanel.com\/?p=53031"},"modified":"2019-07-11T13:00:39","modified_gmt":"2019-07-11T18:00:39","slug":"uapi-whats-new-in-82","status":"publish","type":"post","link":"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/","title":{"rendered":"UAPI- What&#8217;s New in 82"},"content":{"rendered":"\n<p>With the release of cPanel &amp; WHM version 82 to CURRENT this week, we are adding several new&nbsp;<a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/Guide+to+UAPI\">UAPI<\/a>&nbsp;modules and functions.&nbsp;These new functions replace several previously-deprecated&nbsp;<a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/Guide+to+cPanel+API+1\">cPanel API 1<\/a>&nbsp;functions. For a complete list of API calls that we&#8217;ve added so far, read our&nbsp;<a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/Guide+to+Replacing+cPanel+API+1+functions+with+UAPI+equivalents\">Guide to Replacing cPanel API 1 functions with UAPI equivalents<\/a>&nbsp;documentation.<\/p>\n\n\n\n<p>Our goal is to provide a more seamless experience for anyone who integrates with cPanel &amp; WHM.&nbsp;<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">What is an API, and who uses it?<\/h2>\n\n\n\n<p>An <a href=\"https:\/\/www.howtogeek.com\/343877\/what-is-an-api\/\">Application Programming Interface<\/a> (API) is a set of subroutine definitions and communication protocols. These components help connect a software application&#8217;s <a href=\"https:\/\/blog.teamtreehouse.com\/i-dont-speak-your-language-frontend-vs-backend\">backend<\/a> functionality to a user interface (UI). An API can also function as a means for external applications to communicate with the application that defines the API.&nbsp;<\/p>\n\n\n\n<p>When users perform an action in the&nbsp;UI or directly via an API call, the API sends the action to the backend. The backend then responds with the information. If the system can&#8217;t complete the request, the API call returns a meaningful error or warning.<\/p>\n\n\n\n<p>cPanel &amp; WHM uses the API frameworks that ship with our product to build, populate, and create functionality in our UIs. Anyone who wants to integrate with cPanel &amp; WHM can also use these API frameworks.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Wait, cPanel &amp; WHM has an API?<\/h2>\n\n\n\n<p>cPanel &amp; WHM has two active APIs:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/Guide+to+WHM+API+1\">WHM API 1<\/a>&nbsp;\u2014&nbsp;&nbsp;Use this API to access WHM functionality<\/li><li><a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/Guide+to+UAPI\">UAPI<\/a>&nbsp;\u2014&nbsp;&nbsp;Use this API to access cPanel functionality.<\/li><\/ul>\n\n\n\n<p>We also have the following&nbsp;<a href=\"https:\/\/documentation.cpanel.net\/display\/CKB\/cPanel+Deprecation+Plan\">deprecated<\/a>&nbsp;APIs:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/Guide+to+WHM+API+0\">WHM API 0<\/a><\/li><li><a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/Guide+to+cPanel+API+1\">cPanel API 1<\/a><\/li><li><a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/Guide+to+cPanel+API+2\">cPanel API 2<\/a><\/li><\/ul>\n\n\n\n<p>For more information about each of these APIs, read our\u00a0<a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/Quickstart+Development+Guide\">Quickstart Development Guide<\/a>\u00a0documentation.<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/blog.cpanel.com\/wp-content\/uploads\/2019\/07\/api_active_deprecated.png\" alt=\"\" class=\"wp-image-53035\"\/><\/figure>\n\n\n\n<h1 class=\"wp-block-heading\">Why use UAPI?<\/h1>\n\n\n\n<p>We introduced UAPI in cPanel &amp; WHM version 11.42. UAPI provides a more consistent and predictable experience for developers who create integrations and extensions that interact with cPanel. UAPI functions return information in a simple data structure without formatting. This format allows integrators to use the data as needed. UAPI allows developers to&nbsp;<a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/UAPI+-+Filter+Output\">filter<\/a>,&nbsp;<a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/UAPI+-+Sort+Output\">sort<\/a>, and&nbsp;<a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/UAPI+-+Paginate+Output\">paginate<\/a>&nbsp;the output. Additionally, developers can filter returned data into&nbsp;<a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/UAPI+-+Output+Columns\">output columns<\/a>.<\/p>\n\n\n\n<p>Since cPanel API 1 and API 2 are both deprecated, we&nbsp;<strong>strongly<\/strong>&nbsp;recommend using UAPI calls for cPanel integrations whenever possible.&nbsp;We tentatively plan to have all cPanel functionality operating under the UAPI framework by version 86 and plan to completely remove cPanel API 1 from our codebase in version 88.<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/blog.cpanel.com\/wp-content\/uploads\/2019\/07\/apiimage2.png\" alt=\"\" class=\"wp-image-53039\"\/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">A Simple Example<\/h2>\n\n\n\n<p>Imagine you are a web developer with many cPanel user accounts across various servers to help manage your customers&#8217; websites. You want to ensure that those sites don&#8217;t run out of their allocated filesystem space, so you create a dashboard web application. The UAPI&nbsp;<a href=\"https:\/\/documentation.cpanel.net\/display\/DD\/UAPI+Functions+-+Quota%3A%3Aget_quota_info\">Quota::get_quota_info<\/a>&nbsp;call is what you need to get the necessary data to your dashboard.<\/p>\n\n\n\n<p>With a simple API request, it returns the following account information:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>The account&#8217;s megabyte limit.<\/li><li>The account&#8217;s megabytes used.<\/li><li>The account&#8217;s remaining&nbsp;megabytes.<\/li><\/ul>\n\n\n\n<p>You can pass this data into variables within your code that are later&nbsp;used to generate a graph. You&#8217;ve done this for one cPanel instance, but you have three other accounts.<\/p>\n\n\n\n<p>So within each cPanel account, you generate a&nbsp;<a href=\"https:\/\/documentation.cpanel.net\/display\/CKB\/How+to+Use+cPanel+API+Tokens\">cPanel API Token<\/a>. This token allows you to access API functionality for the cPanel account without logging in through the cPanel interface. Now, on a regular interval of time that you&#8217;ve set, your dashboard can automatically poll each cPanel account via the API and retrieve the data you need.<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/blog.cpanel.com\/wp-content\/uploads\/2019\/07\/apiimage3.png\" alt=\"\" class=\"wp-image-53043\"\/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">Tell Us Your Thoughts!<\/h2>\n\n\n\n<p><br>What APIs have you used in the past?\u00a0What features and options make an API great to use? Join in on developer discussions in our\u00a0<a href=\"https:\/\/go.cpanel.net\/discord\">Discord<\/a> integrations\u00a0channel, on our\u00a0<a href=\"https:\/\/forums.cpanel.net\/forums\/cpanel-developers.42\/\">cPanel Developers forum<\/a>, and\u00a0<a href=\"http:\/\/mail.cpanel.net\/mailman\/listinfo\/plugindevs_cpanel.net\">sign up to our Plugin Devs mailing list<\/a>. You can also join us in our\u00a0<a href=\"https:\/\/go.cpanel.net\/slack\">Slack<\/a> channel or our official cPanel <a href=\"https:\/\/reddit.com\/r\/cpane\">subreddit<\/a>!\u00a0Look for future blog posts to include updates related to this API project and monitor our\u00a0<a href=\"https:\/\/documentation.cpanel.net\/display\/82Docs\/82+Release+Notes\">Release Notes<\/a>\u00a0to keep informed about new UAPI functions. <br><br>We look forward to hearing your thoughts and continuing this discussion!<\/p>\n","protected":false},"excerpt":{"rendered":"<p>With the release of cPanel &amp; WHM version 82 to CURRENT this week, we are adding several new&nbsp;UAPI&nbsp;modules and functions.&nbsp;These new functions replace several previously-deprecated&nbsp;cPanel API 1&nbsp;functions. For a complete list of API calls that we&#8217;ve added so far, read our&nbsp;Guide to Replacing cPanel API 1 functions with UAPI equivalents&nbsp;documentation. Our goal is to provide [&hellip;]<\/p>\n","protected":false},"author":77,"featured_media":65193,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"footnotes":""},"categories":[49],"tags":[],"class_list":["post-53031","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-products"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v21.6 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>UAPI- What&#039;s New in 82 | 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\/blog\/products\/uapi-whats-new-in-82\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"UAPI- What&#039;s New in 82 | cPanel\" \/>\n<meta property=\"og:description\" content=\"With the release of cPanel &amp; WHM version 82 to CURRENT this week, we are adding several new&nbsp;UAPI&nbsp;modules and functions.&nbsp;These new functions replace several previously-deprecated&nbsp;cPanel API 1&nbsp;functions. For a complete list of API calls that we&#8217;ve added so far, read our&nbsp;Guide to Replacing cPanel API 1 functions with UAPI equivalents&nbsp;documentation. Our goal is to provide [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/\" \/>\n<meta property=\"og:site_name\" content=\"cPanel\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/cpanel\/\" \/>\n<meta property=\"article:published_time\" content=\"2019-07-11T18:00:39+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/devel.www.cpanel.net\/wp-content\/uploads\/2019\/07\/2019.07.11.uapiupdates.png\" \/>\n\t<meta property=\"og:image:width\" content=\"2000\" \/>\n\t<meta property=\"og:image:height\" content=\"792\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"cPanel Community\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@cPanel\" \/>\n<meta name=\"twitter:site\" content=\"@cPanel\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"cPanel Community\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/\",\"url\":\"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/\",\"name\":\"UAPI- What's New in 82 | cPanel\",\"isPartOf\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/#website\"},\"datePublished\":\"2019-07-11T18:00:39+00:00\",\"dateModified\":\"2019-07-11T18:00:39+00:00\",\"author\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/#\/schema\/person\/8cf97408aad4fb70cf55d11a1d4f57f8\"},\"breadcrumb\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/devel.www.cpanel.net\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"UAPI- What&#8217;s New in 82\"}]},{\"@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\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/devel.www.cpanel.net\/#\/schema\/person\/8cf97408aad4fb70cf55d11a1d4f57f8\",\"name\":\"cPanel Community\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/devel.www.cpanel.net\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/e1949945083b5526bb95711bd3d616b3?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/e1949945083b5526bb95711bd3d616b3?s=96&d=mm&r=g\",\"caption\":\"cPanel Community\"},\"description\":\"The web hosting industry's most reliable management solution since 1997. With our first-class support and rich feature set, it's easy to see why our customers and partners make cPanel &amp; WHM their hosting platform of choice. For more information, visit cPanel.net.\",\"sameAs\":[\"https:\/\/cpanel.net\"],\"url\":\"https:\/\/devel.www.cpanel.net\/blog\/author\/cpadmin\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"UAPI- What's New in 82 | 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\/blog\/products\/uapi-whats-new-in-82\/","og_locale":"en_US","og_type":"article","og_title":"UAPI- What's New in 82 | cPanel","og_description":"With the release of cPanel &amp; WHM version 82 to CURRENT this week, we are adding several new&nbsp;UAPI&nbsp;modules and functions.&nbsp;These new functions replace several previously-deprecated&nbsp;cPanel API 1&nbsp;functions. For a complete list of API calls that we&#8217;ve added so far, read our&nbsp;Guide to Replacing cPanel API 1 functions with UAPI equivalents&nbsp;documentation. Our goal is to provide [&hellip;]","og_url":"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/","og_site_name":"cPanel","article_publisher":"https:\/\/www.facebook.com\/cpanel\/","article_published_time":"2019-07-11T18:00:39+00:00","og_image":[{"width":2000,"height":792,"url":"https:\/\/devel.www.cpanel.net\/wp-content\/uploads\/2019\/07\/2019.07.11.uapiupdates.png","type":"image\/png"}],"author":"cPanel Community","twitter_card":"summary_large_image","twitter_creator":"@cPanel","twitter_site":"@cPanel","twitter_misc":{"Written by":"cPanel Community","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/","url":"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/","name":"UAPI- What's New in 82 | cPanel","isPartOf":{"@id":"https:\/\/devel.www.cpanel.net\/#website"},"datePublished":"2019-07-11T18:00:39+00:00","dateModified":"2019-07-11T18:00:39+00:00","author":{"@id":"https:\/\/devel.www.cpanel.net\/#\/schema\/person\/8cf97408aad4fb70cf55d11a1d4f57f8"},"breadcrumb":{"@id":"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/devel.www.cpanel.net\/blog\/products\/uapi-whats-new-in-82\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/devel.www.cpanel.net\/"},{"@type":"ListItem","position":2,"name":"UAPI- What&#8217;s New in 82"}]},{"@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"},{"@type":"Person","@id":"https:\/\/devel.www.cpanel.net\/#\/schema\/person\/8cf97408aad4fb70cf55d11a1d4f57f8","name":"cPanel Community","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/devel.www.cpanel.net\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/e1949945083b5526bb95711bd3d616b3?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/e1949945083b5526bb95711bd3d616b3?s=96&d=mm&r=g","caption":"cPanel Community"},"description":"The web hosting industry's most reliable management solution since 1997. With our first-class support and rich feature set, it's easy to see why our customers and partners make cPanel &amp; WHM their hosting platform of choice. For more information, visit cPanel.net.","sameAs":["https:\/\/cpanel.net"],"url":"https:\/\/devel.www.cpanel.net\/blog\/author\/cpadmin\/"}]}},"_links":{"self":[{"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/posts\/53031"}],"collection":[{"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/users\/77"}],"replies":[{"embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/comments?post=53031"}],"version-history":[{"count":0,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/posts\/53031\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/media\/65193"}],"wp:attachment":[{"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/media?parent=53031"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/categories?post=53031"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/tags?post=53031"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}