{"id":67,"date":"2010-04-15T13:43:38","date_gmt":"2010-04-15T18:43:38","guid":{"rendered":"http:\/\/blogs.wp.stage.cpanel.net\/2010\/04\/spotlight_on_api_docs_writing_a_cpanel_plugin\/"},"modified":"2010-04-15T13:43:38","modified_gmt":"2010-04-15T18:43:38","slug":"spotlight_on_api_docs_writing_a_cpanel_plugin","status":"publish","type":"post","link":"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/","title":{"rendered":"Spotlight On: API Docs &#038; Writing a cPanel Plugin"},"content":{"rendered":"<p>As of today, cPanel\u2019s API1 and API2 are fully <a href=\"http:\/\/docs.cpanel.net\/twiki\/bin\/view\/ApiDocs\/\" target=\"_blank\" rel=\"noopener\">documented<\/a>. cPanel\u2019s <em>x3<\/em> interface is entirely API-driven, meaning that every action you can perform in the cPanel interface is now documented and can be automated through our XML-API or reimplemented in a unique theme.<\/p>\n<p>Accompanying the complete release of our API documentation is a guide called <a href=\"http:\/\/docs.cpanel.net\/twiki\/bin\/view\/AllDocumentation\/AutomationIntegration\/WritingcPanelPlugins\" target=\"_blank\" rel=\"noopener\">Writing cPanel Plugins<\/a>. These documents cover all of the steps required to create a cPanel plugin, in addition to some tools you can use.<\/p>\n<p>These tools include:<\/p>\n<ul>\n<li><a href=\"http:\/\/docs.cpanel.net\/twiki\/bin\/view\/AllDocumentation\/AutomationIntegration\/LivePHP\" target=\"_blank\" rel=\"noopener\">LivePHP<\/a> &#8211; A PHP class that allows you to use object-oriented programming to access cPanel&#8217;s APIs<\/li>\n<li><a href=\"http:\/\/docs.cpanel.net\/twiki\/bin\/view\/AllDocumentation\/AutomationIntegration\/UsingCpttTags\" target=\"_blank\" rel=\"noopener\">cPanel Template Toolkit<\/a> (cptt tags) &#8211; A template-driven API2 parser that utilizes the <a href=\"http:\/\/template-toolkit.org\" target=\"_blank\" rel=\"noopener\">Template::Toolkit<\/a> library, making API2 easier to use.<\/li>\n<\/ul>\n<p>As always, if you need help, don\u2019t hesitate to post in the <a href=\"http:\/\/forums.cpanel.net\/cpanel-developers.html\" target=\"_blank\" rel=\"noopener\">Developer Discussion forum<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>As of today, cPanel\u2019s API1 and API2 are fully documented. cPanel\u2019s x3 interface is entirely API-driven, meaning that every action you can perform in the cPanel interface is now documented and can be automated through our XML-API or reimplemented in a unique theme. Accompanying the complete release of our API documentation is a guide called [&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":[],"class_list":["post-67","post","type-post","status-publish","format-standard","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>Spotlight On: API Docs &amp; Writing a cPanel Plugin | 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\/spotlight_on_api_docs_writing_a_cpanel_plugin\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Spotlight On: API Docs &amp; Writing a cPanel Plugin | cPanel\" \/>\n<meta property=\"og:description\" content=\"As of today, cPanel\u2019s API1 and API2 are fully documented. cPanel\u2019s x3 interface is entirely API-driven, meaning that every action you can perform in the cPanel interface is now documented and can be automated through our XML-API or reimplemented in a unique theme. Accompanying the complete release of our API documentation is a guide called [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/\" \/>\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=\"2010-04-15T18:43:38+00:00\" \/>\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=\"1 minute\" \/>\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\/spotlight_on_api_docs_writing_a_cpanel_plugin\/\",\"url\":\"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/\",\"name\":\"Spotlight On: API Docs & Writing a cPanel Plugin | cPanel\",\"isPartOf\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/#website\"},\"datePublished\":\"2010-04-15T18:43:38+00:00\",\"dateModified\":\"2010-04-15T18:43:38+00:00\",\"author\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/#\/schema\/person\/8cf97408aad4fb70cf55d11a1d4f57f8\"},\"breadcrumb\":{\"@id\":\"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/devel.www.cpanel.net\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Spotlight On: API Docs &#038; Writing a cPanel Plugin\"}]},{\"@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":"Spotlight On: API Docs & Writing a cPanel Plugin | 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\/spotlight_on_api_docs_writing_a_cpanel_plugin\/","og_locale":"en_US","og_type":"article","og_title":"Spotlight On: API Docs & Writing a cPanel Plugin | cPanel","og_description":"As of today, cPanel\u2019s API1 and API2 are fully documented. cPanel\u2019s x3 interface is entirely API-driven, meaning that every action you can perform in the cPanel interface is now documented and can be automated through our XML-API or reimplemented in a unique theme. Accompanying the complete release of our API documentation is a guide called [&hellip;]","og_url":"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/","og_site_name":"cPanel","article_publisher":"https:\/\/www.facebook.com\/cpanel\/","article_published_time":"2010-04-15T18:43:38+00:00","author":"cPanel Community","twitter_card":"summary_large_image","twitter_creator":"@cPanel","twitter_site":"@cPanel","twitter_misc":{"Written by":"cPanel Community","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/","url":"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/","name":"Spotlight On: API Docs & Writing a cPanel Plugin | cPanel","isPartOf":{"@id":"https:\/\/devel.www.cpanel.net\/#website"},"datePublished":"2010-04-15T18:43:38+00:00","dateModified":"2010-04-15T18:43:38+00:00","author":{"@id":"https:\/\/devel.www.cpanel.net\/#\/schema\/person\/8cf97408aad4fb70cf55d11a1d4f57f8"},"breadcrumb":{"@id":"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/devel.www.cpanel.net\/blog\/products\/spotlight_on_api_docs_writing_a_cpanel_plugin\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/devel.www.cpanel.net\/"},{"@type":"ListItem","position":2,"name":"Spotlight On: API Docs &#038; Writing a cPanel Plugin"}]},{"@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\/67"}],"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=67"}],"version-history":[{"count":0,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/posts\/67\/revisions"}],"wp:attachment":[{"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/media?parent=67"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/categories?post=67"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devel.www.cpanel.net\/wp-json\/wp\/v2\/tags?post=67"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}