Joomla! Downloads API Documentation

<!DOCTYPE html> <html> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="apple-mobile-web-app-capable" content="yes" /> <meta name="apple-mobile-web-app-status-bar-style" content="blue" /> <meta name="twitter:card" content="summary_large_image" /> <meta name="twitter:site" content="@joomla" /> <meta name="twitter:description" content="Joomla! Downloads API Documentation" /> <meta name="twitter:image" content="https://cdn.joomla.org/images/sharing/joomla-twitter-card.png" /> <meta name="twitter:title" content="Joomla! Downloads API Documentation" /> <meta name="referrer" content="unsafe-url" /> <meta property="og:site_name" content="Joomla! Downloads API Documentation" /> <meta property="og:image" content="https://cdn.joomla.org/images/sharing/joomla-org-og.jpg" /> <meta name="description" content="Joomla! Downloads API Documentation" /> <meta name="generator" content="Joomla! - Open Source Content Management" /> <title>Joomla! Downloads API Documentation</title> <link href="https://downloads.joomla.org/templates/joomla/images/apple-touch-icon-180x180.png" rel="apple-touch-icon" sizes="180x180" /> <link href="https://downloads.joomla.org/templates/joomla/images/apple-touch-icon-152x152.png" rel="apple-touch-icon" sizes="152x152" /> <link href="https://downloads.joomla.org/templates/joomla/images/apple-touch-icon-144x144.png" rel="apple-touch-icon" sizes="144x144" /> <link href="https://downloads.joomla.org/templates/joomla/images/apple-touch-icon-120x120.png" rel="apple-touch-icon" sizes="120x120" /> <link href="https://downloads.joomla.org/templates/joomla/images/apple-touch-icon-114x114.png" rel="apple-touch-icon" sizes="114x114" /> <link href="https://downloads.joomla.org/templates/joomla/images/apple-touch-icon-76x76.png" rel="apple-touch-icon" sizes="76x76" /> <link href="https://downloads.joomla.org/templates/joomla/images/apple-touch-icon-72x72.png" rel="apple-touch-icon" sizes="72x72" /> <link href="https://downloads.joomla.org/templates/joomla/images/apple-touch-icon-57x57.png" rel="apple-touch-icon" sizes="57x57" /> <link href="https://downloads.joomla.org/templates/joomla/images/apple-touch-icon.png" rel="apple-touch-icon" /> <link href="https://downloads.joomla.org/templates/joomla/css/template.min.css?2.2.1-dev&1493126506" rel="stylesheet" /> <link href="https://downloads.joomla.org/templates/joomla/css/custom.css?173662b00a11d09cb8eeb4326ac80785&1500830466" rel="stylesheet" /> <link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" /> <style> h1, h2, h3, h4, h5, h6 { font-family: 'Open Sans', sans-serif; } .http_method { text-transform: uppercase; } .description-tab div { margin-left: 1em; } .description-tab .propName { font-weight: bold; } </style> <script src='lib/object-assign-pollyfill.js' type='text/javascript'></script> <script src="https://downloads.joomla.org/media/jui/js/jquery.min.js?173662b00a11d09cb8eeb4326ac80785&1499159052"></script> <script src="https://downloads.joomla.org/media/jui/js/jquery-migrate.min.js?173662b00a11d09cb8eeb4326ac80785&1499159052"></script> <script src="https://downloads.joomla.org/media/jui/js/bootstrap.min.js?173662b00a11d09cb8eeb4326ac80785&1499159052"></script> <script src="https://downloads.joomla.org/templates/joomla/js/template.js?173662b00a11d09cb8eeb4326ac80785&1493126506"></script> <script src="https://downloads.joomla.org/templates/joomla/js/blockadblock.js?173662b00a11d09cb8eeb4326ac80785&1493126506"></script> <script src="https://downloads.joomla.org/templates/joomla/js/js.cookie.js?173662b00a11d09cb8eeb4326ac80785&1493126506"></script> <script src='lib/jquery.slideto.min.js' type='text/javascript'></script> <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script> <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script> <script src='lib/handlebars-4.0.5.js' type='text/javascript'></script> <script src='lib/lodash.min.js' type='text/javascript'></script> <script src='lib/backbone-min.js' type='text/javascript'></script> <script src='swagger-ui.js' type='text/javascript'></script> <script src='lib/highlight.9.1.0.pack.js' type='text/javascript'></script> <script src='lib/highlight.9.1.0.pack_extended.js' type='text/javascript'></script> <script src='lib/jsoneditor.min.js' type='text/javascript'></script> <script src='lib/marked.js' type='text/javascript'></script> <script src='lib/swagger-oauth.js' type='text/javascript'></script>     <script type="text/javascript"> jQuery(function () { var pathArray = location.href.split('/'), protocol = pathArray[0], host = pathArray[2], baseUrl = protocol + '//' + host; var url = baseUrl + "/libraries/api/application/open_api.json"; hljs.configure({ highlightSizeThreshold: 5000 }); // Pre load translate... if (window.SwaggerTranslator) { window.SwaggerTranslator.translate(); } window.swaggerUi = new SwaggerUi({ url: url, dom_id: "swagger-ui-container", supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'], onComplete: function (swaggerApi, swaggerUi) { if (typeof initOAuth == "function") { initOAuth({ clientId: "your-client-id", clientSecret: "your-client-secret-if-required", realm: "your-realms", appName: "your-app-name", scopeSeparator: " ", additionalQueryStringParams: {} }); } if (window.SwaggerTranslator) { window.SwaggerTranslator.translate(); } }, onFailure: function (data) { log("Unable to Load SwaggerUI"); }, docExpansion: "none", jsonEditor: false, defaultModelRendering: 'schema', showRequestHeaders: false }); window.swaggerUi.load(); function log() { if ('console' in window) { console.log.apply(console, arguments); } } }); </script> </head> <body class="site swagger-section">  <noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-KR9CX8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KR9CX8');</script>   <nav class="navigation" role="navigation"> <div id="mega-menu" class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> <div class="container"> <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </a> <div class="nav-collapse collapse"> <ul id="nav-joomla" class="nav"> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#"> <span dir="ltr"><span aria-hidden="true" class="icon-joomla"></span> Joomla!<sup>®</sup></span> <span class="caret"></span> </a> <ul class="dropdown-menu"> <li class="nav-header"><span>About us</span></li> <li> <a href="https://www.joomla.org"> <span aria-hidden="true" class="icon-joomla"></span> Joomla Home </a> </li> <li><a href="https://www.joomla.org/about-joomla.html">What is Joomla?</a></li> <li><a href="https://www.joomla.org/core-features.html">Benefits & Features</a></li> <li><a href="https://www.joomla.org/about-joomla/the-project.html">Project & Leadership</a></li> <li><a href="https://tm.joomla.org">Trademark & Licensing</a></li> <li><a href="https://joomlafoundation.org">The Joomla Foundation</a></li> <li class="divider"></li> <li class="nav-header"><span>Support us</span></li> <li><a href="https://www.joomla.org/contribute-to-joomla.html">Contribute</a></li> <li><a href="https://www.joomla.org/sponsor.html">Sponsor</a></li> <li><a href="https://www.joomla.org/about-joomla/partners.html">Partner</a></li> <li><a href="https://shop.joomla.org">Shop</a></li> </ul> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Download & Extend <span class="caret"></span></a> <ul class="dropdown-menu"> <li><a href="https://downloads.joomla.org">Downloads</a></li> <li><a href="https://extensions.joomla.org">Extensions</a></li> <li><a href="https://downloads.joomla.org/language-packs">Languages</a></li> <li><a href="https://launch.joomla.org">Get a free site</a></li> <li><a href="https://domains.joomla.org">Get a domain</a></li> </ul> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Discover & Learn <span class="caret"></span></a> <ul class="dropdown-menu"> <li><a href="https://docs.joomla.org">Documentation</a></li> <li><a href="https://community.joomla.org/joomla-training.html">Training</a></li> <li><a href="https://certification.joomla.org">Certification</a></li> <li><a href="https://showcase.joomla.org">Site Showcase</a></li> <li><a href="https://www.joomla.org/announcements.html">Announcements</a></li> <li><a href="https://community.joomla.org/blogs.html">Blogs</a></li> <li><a href="https://magazine.joomla.org">Magazine</a></li> </ul> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community & Support <span class="caret"></span></a> <ul class="dropdown-menu"> <li><a href="https://community.joomla.org">Community Portal</a></li> <li><a href="https://community.joomla.org/events.html">Events</a></li> <li><a href="https://community.joomla.org/user-groups.html">User Groups</a></li> <li><a href="https://forum.joomla.org">Forum</a></li> <li><a href="https://community.joomla.org/service-providers-directory.html">Service Providers Directory</a></li> <li><a href="https://volunteers.joomla.org">Volunteers Portal</a></li> <li><a href="https://extensions.joomla.org/vulnerable-extensions/vulnerable/">Vulnerable Extensions List</a></li> </ul> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Developer Resources <span class="caret"></span></a> <ul class="dropdown-menu"> <li><a href="https://developer.joomla.org">Developer Network</a></li> <li><a href="https://developer.joomla.org/security.html">Security Centre</a></li> <li><a href="https://issues.joomla.org">Issue Tracker</a></li> <li><a href="https://github.com/joomla">GitHub</a></li> <li><a href="https://api.joomla.org">API Documentation</a></li> <li><a href="https://framework.joomla.org"><span dir="ltr">Joomla!</span> Framework</a></li> </ul> </li> </ul> </div> </div> </div> </div> </nav> <header class="header"> <div class="container"> <div class="row-fluid"> <div class="span7"> <h1 class="page-title"><a href="https://downloads.joomla.org">Joomla! Downloads</a></h1> </div> <div class="span5"> <div class="btn-toolbar pull-right"> <div class="btn-group"> <a href="https://downloads.joomla.org" class="btn btn-large btn-warning">Download</a> </div> <div class="btn-group"> <a href="https://demo.joomla.org" class="btn btn-large btn-primary">Demo</a> </div> </div> </div> </div> </div> </header> <div class="subnav-wrapper"> <div class="subnav"> <div class="container"> <ul class="nav menu nav-pills"> <li class="default"><a href="https://downloads.joomla.org">Home</a></li> <li><a href="https://downloads.joomla.org/latest">Latest Release</a></li> <li><a href="https://downloads.joomla.org/cms">Downloads</a></li> <li><a href="https://downloads.joomla.org/extensions">Extensions</a></li> <li><a href="https://downloads.joomla.org/technical-requirements">Technical Requirements</a></li> <li><a href="https://downloads.joomla.org/faqs">FAQs</a></li> <li class="active"><a href="https://downloads.joomla.org/api-docs/">API Documentation</a></li> </ul> </div> </div> </div> <div class="body"> <div class="container"> <noscript> <div class="alert alert-warning"> Javascript is disabled; several features are only available if Javascript is enabled. </div> </noscript> <div class="row-fluid"> <main class="span12"> <div id="message-bar" class="swagger-ui-wrap" data-sw-translate> </div> <div id="swagger-ui-container" class="swagger-ui-wrap"></div> </main> </div> </div> </div> <footer class="footer center"> <div class="container"> <hr /> <div class="social"> <ul class="soc"> <li><a href="https://twitter.com/joomla" target="_blank" rel="noopener" class="icon-twitter2" title="Joomla! on Twitter"><span class="element-invisible">Joomla! on Twitter</span></a></li> <li><a href="https://www.facebook.com/joomla" target="_blank" rel="noopener" class="icon-facebook2" title="Joomla! on Facebook"><span class="element-invisible">Joomla! on Facebook</span></a></li> <li><a href="https://www.youtube.com/user/joomla" target="_blank" rel="noopener"class="icon-youtube3" title="Joomla! on YouTube"><span class="element-invisible">Joomla! on YouTube</span></a></li> <li><a href="https://www.linkedin.com/company/joomla" target="_blank" rel="noopener" class="icon-linkedin" title="Joomla! on LinkedIn"><span class="element-invisible">Joomla! on LinkedIn</span></a></li> <li><a href="https://www.pinterest.com/joomla" target="_blank" rel="noopener" class="icon-pinterest2" title="Joomla! on Pinterest"><span class="element-invisible">Joomla! on Pinterest</span></a></li> <li><a href="https://www.instagram.com/joomlaofficial/" target="_blank" rel="noopener" class="icon-instagram" title="Joomla! on Instagram"><span class="element-invisible">Joomla! on Instagram</span></a></li> <li><a href="https://github.com/joomla" target="_blank" rel="noopener" class="icon-github3" title="Joomla! on GitHub"><span class="element-invisible">Joomla! on GitHub</span></a></li> </ul> </div> <div class="footer-menu"> <ul class="nav-inline"> <li><a href="https://www.joomla.org"><span>Home</span></a></li> <li><a href="https://www.joomla.org/about-joomla.html"><span>About</span></a></li> <li><a href="https://community.joomla.org"><span>Community</span></a></li> <li><a href="https://forum.joomla.org"><span>Forum</span></a></li> <li><a href="https://extensions.joomla.org"><span>Extensions</span></a></li> <li><a href="https://community.joomla.org/service-providers-directory.html"><span>Services</span></a></li> <li><a href="https://docs.joomla.org"><span>Docs</span></a></li> <li><a href="https://developer.joomla.org"><span>Developer</span></a></li> <li><a href="https://community.joomla.org/the-joomla-shop.html"><span>Shop</span></a></li> </ul> <ul class="nav-inline"> <li><a href="https://www.joomla.org/accessibility-statement.html">Accessibility Statement</a></li> <li><a href="https://www.joomla.org/privacy-policy.html">Privacy Policy</a></li> <li><a href="https://www.joomla.org/cookie-policy.html">Cookie Policy</a></li> <li><a href="https://community.joomla.org/sponsorship-campaigns.html">Sponsor Joomla! with $5</a></li> <li><a href="https://joomla.crowdin.com" target="_blank" rel="noopener">Help Translate</a></li> <li><a href="https://github.com/joomla/joomla-websites/issues/new?title=%5Bjapi%5D%20">Report an Issue</a></li> </ul> <p class="copyright">© 2005 <a href="https://www.opensourcematters.org">Open Source Matters, Inc.</a> All Rights Reserved.</p> <div class="hosting"> <div class="hosting-image"><a href="https://www.rochen.com/joomla-hosting" rel="noopener" target="_blank"><img class="rochen" width="84" height="42" src="https://cdn.joomla.org/rochen/rochen_footer_logo_white.png" alt="Rochen" /></a></div> <div class="hosting-text"><a href="https://www.rochen.com/joomla-hosting" rel="noopener" target="_blank"><span dir="ltr">Joomla!</span> Hosting by Rochen</a></div> </div> </div> </div> </footer> </body> </html>

CINXE.COM

Joomla! Downloads API Documentation