{"id":46989,"date":"2017-11-22T13:00:00","date_gmt":"2017-11-22T19:00:00","guid":{"rendered":"https:\/\/blog.cpanel.com\/?p=46989"},"modified":"2017-11-22T13:00:00","modified_gmt":"2017-11-22T19:00:00","slug":"improvements-to-cpanel-account-package-extensions","status":"publish","type":"post","link":"https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/","title":{"rendered":"Improvements to cPanel Account Package Extensions"},"content":{"rendered":"<p>cPanel &amp; WHM is a very powerful piece of software, that allows\u00a0server\u00a0managers to more easily\u00a0<span class=\"inline-comment-marker\" data-ref=\"78a8c11e-53d7-493d-9251-abb3f3c863a3\">manage<\/span>\u00a0their servers. The real power, though, comes from its extendability. In most\u00a0webhosting\u00a0environments, cPanel accounts are built using\u00a0<a href=\"https:\/\/documentation.cpanel.net\/display\/68Docs\/Create+a+New+Account+-+Package\"><span class=\"inline-comment-marker\" data-ref=\"0a791368-d8ff-45d8-969f-5e6c01629a1d\">Account Packages<\/span><\/a>. To help cPanel &amp; WHM integrators, we released a new feature four years ago, in cPanel &amp; WHM version 11.40, called\u00a0<a href=\"https:\/\/documentation.cpanel.net\/display\/SDK\/Guide+to+Package+Extensions\">package extensions<\/a>. Package extensions allow our technology partners like CloudLinux to extend cPanel account packages to include their own features.\u00a0However, features that we have added starting\u00a0<span class=\"inline-comment-marker\" data-ref=\"822ffe1c-8cdd-4565-a48f-808f7c5039c3\">in version 60<\/span>\u00a0have caused unintended problems with package extensions. We have markedly improved this interaction in version 68.<\/p>\n<h2>The old problem with editing packages in 66 and below<\/h2>\n<p>Customers and third-party developers have successfully used our package extensions for many years. However, in the last two years or so when they attempt to edit a package to add a package extension using the\u00a0<code><a href=\"https:\/\/documentation.cpanel.net\/display\/SDK\/WHM+API+1+Functions+-+editpkg\">editpkg<\/a><\/code>\u00a0WHMAPI1 call, they trigger a problematic series of events.\u00a0The below scenario explains the problem we needed to fix.<\/p>\n<p>Consider a package named &#8216;Rutabaga&#8217; which allows accounts to use\u00a0up to 1024M of bandwidth per month. Five accounts are subscribed to the package.\u00a0The image below shows what that might look like.<\/p>\n<p><img decoding=\"async\" class=\"aligncenter\" src=\"https:\/\/blog.cpanel.com\/wp-content\/uploads\/2017\/11\/1-600x233.png\" alt=\"Package extensions improved 1\" \/><\/p>\n<p>The hosting provider then\u00a0<a href=\"https:\/\/documentation.cpanel.net\/display\/68Docs\/Limit+Bandwidth+Usage\">modifies account number five<\/a>, allowing them to use up to 2048M of bandwidth per month. We now have a common situation where account number five is assigned to the Rutabaga package, with a custom value for the bandwidth limit. The other accounts are still using the value for bandwidth specified in the Rutabaga package.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter\" src=\"https:\/\/blog.cpanel.com\/wp-content\/uploads\/2017\/11\/2-600x233.png\" alt=\"Package extensions improved 2\" width=\"600\" height=\"233\" \/><\/p>\n<p>Here is where the problem comes in: when the package, Rutabaga, is edited to add a package extension, the accounts subscribed to the package have their limits reset to the values specified in the package.\u00a0In our scenario, account number five will have her bandwidth limit reset to match the rest of the accounts assigned to the\u00a0Rutabaga package.<\/p>\n<p><img decoding=\"async\" class=\"aligncenter\" src=\"https:\/\/blog.cpanel.com\/wp-content\/uploads\/2017\/11\/4-600x233.png\" alt=\"pkg extentions improved 3\" \/><\/p>\n<p>From research and conversations, the expectation is for the\u00a0custom\u00a0limits defined in an account to be retained, so that&#8217;s what we wanted to fix.<\/p>\n<h2>New functions in Version 68!<\/h2>\n<p>Instead of changing the functionality of the existing API function and potentially breaking existing integrations, we opted to add additional functionality that could be incorporated by our integrators over time. In version 68 we added two new WHM API 1 functions to manage package extensions on packages:\u00a0<code><a href=\"https:\/\/documentation.cpanel.net\/display\/SDK\/WHM+API+1+Functions+-+addpkgext\">addpkgext<\/a><\/code>\u00a0and\u00a0<code><a href=\"https:\/\/documentation.cpanel.net\/display\/SDK\/WHM+API+1+Functions+-+delpkgext\">delpkgext<\/a><\/code>.\u00a0In the above scenario, if the integrator uses\u00a0<code>addpkgext<\/code>\u00a0instead of\u00a0<code>editpkg<\/code>, the custom bandwidth limit will be retained, and the customer will remain unimpacted.<\/p>\n<p><img decoding=\"async\" class=\"aligncenter\" src=\"https:\/\/blog.cpanel.com\/wp-content\/uploads\/2017\/11\/5-600x233.png\" alt=\"Package extensions improved 4\" \/><\/p>\n<p>If your integration has historically needed to edit a package extension setting we recommend that you now use\u00a0the\u00a0<code>addpkgext<\/code>\u00a0function\u00a0in your integration. Running the\u00a0<code>addpkgext<\/code>\u00a0function against a package that already has that extension defined will result in the same package extension being\u00a0added with\u00a0the desired setting.<\/p>\n<p>Though we did\u00a0not deprecate or remove\u00a0the\u00a0<code>package extensions<\/code>\u00a0parameter\u00a0in the\u00a0<code>editpkg<\/code>\u00a0WHM API 1 function (to avoid the aforementioned potential errors),\u00a0we\u00a0<strong>strongly<\/strong>\u00a0recommend that any existing integrators modify them to use the\u00a0new\u00a0<code>addpkgext<\/code>\u00a0and\u00a0<code>delpkgext<\/code>\u00a0functions\u00a0to handle package extension management.<\/p>\n<h2>What are your other integration pain points?<\/h2>\n<p>These functions are now used by our user interfaces and scripts as well, to ensure a consistent experience, and we will eventually move toward deprecating the\u00a0<code>editpkg<\/code>\u00a0call. For now,\u00a0though: What\u00a0other API and integration improvements would you like to see?<\/p>\n<p>If you need help with your integrations, the best place to get it is our developer forum\u00a0<a href=\"https:\/\/forums.cpanel.net\/forums\/cpanel-developers.42\/\">on the cPanel Forums<\/a>, but you can always comment below,\u00a0<a href=\"https:\/\/twitter.com\/cpaneldev\"><span class=\"inline-comment-marker\" data-ref=\"1133e02d-e2a2-44f0-908e-334f2e86b50f\">find me on twitter<\/span><\/a><span class=\"inline-comment-marker\" data-ref=\"1133e02d-e2a2-44f0-908e-334f2e86b50f\">, or\u00a0<\/span><a href=\"mailto:benny@cpanel.net\"><span class=\"inline-comment-marker\" data-ref=\"1133e02d-e2a2-44f0-908e-334f2e86b50f\">send me an email<\/span><\/a><span class=\"inline-comment-marker\" data-ref=\"1133e02d-e2a2-44f0-908e-334f2e86b50f\">!<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"<p>cPanel &amp; WHM is a very powerful piece of software, that allows\u00a0server\u00a0managers to more easily\u00a0manage\u00a0their servers. The real power, though, comes from its extendability. In most\u00a0webhosting\u00a0environments, cPanel accounts are built using\u00a0Account Packages. To help cPanel &amp; WHM integrators, we released a new feature four years ago, in cPanel &amp; WHM version 11.40, called\u00a0package extensions. Package [&hellip;]<\/p>\n","protected":false},"author":77,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"footnotes":""},"categories":[49],"tags":[1893,1897,1901,1745,1905,1465],"class_list":["post-46989","post","type-post","status-publish","format-standard","hentry","category-products","tag-how-to-add-to-packages","tag-integrators","tag-package-extensions","tag-v68","tag-whmapi","tag-whmapi1"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v21.6 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Improvements to cPanel Account Package Extensions | 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\/improvements-to-cpanel-account-package-extensions\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Improvements to cPanel Account Package Extensions | cPanel\" \/>\n<meta property=\"og:description\" content=\"cPanel &amp; WHM is a very powerful piece of software, that allows\u00a0server\u00a0managers to more easily\u00a0manage\u00a0their servers. The real power, though, comes from its extendability. In most\u00a0webhosting\u00a0environments, cPanel accounts are built using\u00a0Account Packages. To help cPanel &amp; WHM integrators, we released a new feature four years ago, in cPanel &amp; WHM version 11.40, called\u00a0package extensions. Package [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/\" \/>\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=\"2017-11-22T19:00:00+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/blog.cpanel.com\/wp-content\/uploads\/2017\/11\/1-600x233.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\/improvements-to-cpanel-account-package-extensions\/\",\"url\":\"https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/\",\"name\":\"Improvements to cPanel Account Package Extensions | cPanel\",\"isPartOf\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/#website\"},\"datePublished\":\"2017-11-22T19:00:00+00:00\",\"dateModified\":\"2017-11-22T19:00:00+00:00\",\"author\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/#\/schema\/person\/8cf97408aad4fb70cf55d11a1d4f57f8\"},\"breadcrumb\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/devel.www.cpanel.net\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Improvements to cPanel Account Package Extensions\"}]},{\"@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":"Improvements to cPanel Account Package Extensions | 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\/improvements-to-cpanel-account-package-extensions\/","og_locale":"en_US","og_type":"article","og_title":"Improvements to cPanel Account Package Extensions | cPanel","og_description":"cPanel &amp; WHM is a very powerful piece of software, that allows\u00a0server\u00a0managers to more easily\u00a0manage\u00a0their servers. The real power, though, comes from its extendability. In most\u00a0webhosting\u00a0environments, cPanel accounts are built using\u00a0Account Packages. To help cPanel &amp; WHM integrators, we released a new feature four years ago, in cPanel &amp; WHM version 11.40, called\u00a0package extensions. Package [&hellip;]","og_url":"https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/","og_site_name":"cPanel","article_publisher":"https:\/\/www.facebook.com\/cpanel\/","article_published_time":"2017-11-22T19:00:00+00:00","og_image":[{"url":"https:\/\/blog.cpanel.com\/wp-content\/uploads\/2017\/11\/1-600x233.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\/improvements-to-cpanel-account-package-extensions\/","url":"https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/","name":"Improvements to cPanel Account Package Extensions | cPanel","isPartOf":{"@id":"https:\/\/devel.www.cpanel.net\/#website"},"datePublished":"2017-11-22T19:00:00+00:00","dateModified":"2017-11-22T19:00:00+00:00","author":{"@id":"https:\/\/devel.www.cpanel.net\/#\/schema\/person\/8cf97408aad4fb70cf55d11a1d4f57f8"},"breadcrumb":{"@id":"https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/devel.www.cpanel.net\/blog\/products\/improvements-to-cpanel-account-package-extensions\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/devel.www.cpanel.net\/"},{"@type":"ListItem","position":2,"name":"Improvements to cPanel Account Package Extensions"}]},{"@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\/46989"}],"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=46989"}],"version-history":[{"count":0,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/posts\/46989\/revisions"}],"wp:attachment":[{"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/media?parent=46989"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/categories?post=46989"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/tags?post=46989"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}