OpenStack Docs: API references

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml"> <head> <meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>    <title> OpenStack Docs: API references </title> <meta charset="utf-8"/> <meta content="IE=edge" http-equiv="X-UA-Compatible"/> <meta content="width=device-width, initial-scale=1" name="viewport"/>  <link href="https://docs.openstack.org/common/css/bootstrap.css" rel="stylesheet"/>  <link href="https://docs.openstack.org/common/css/combined.css" rel="stylesheet"/>  <link href="https://docs.openstack.org/common/css/search.css" rel="stylesheet"/>  <link crossorigin="anonymous" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" rel="stylesheet"/> <link href="https://use.fontawesome.com/releases/v5.6.3/css/v4-shims.css" rel="stylesheet"/> <link href="https://docs.openstack.org/common/css/font-awesome-additions.css" rel="stylesheet"/>      <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-17511903-1', 'auto'); ga('send', 'pageview'); </script>  </head> <body>   <script> (function (window, document) { var loader = function () { var script = document.createElement("script"), tag = document.getElementsByTagName("script")[0]; script.src = "https://search.openstack.org/widget/embed.min.js?t="+Date.now(); tag.parentNode.insertBefore(script, tag); }; window.addEventListener ? window.addEventListener("load", loader, false) : window.attachEvent("onload", loader); })(window, document); </script> <nav class="navbar navbar-default inner" role="navigation"> <div class="container">  <div class="navbar-header"> <button class="navbar-toggle" data-target="#bs-example-navbar-collapse-1" data-toggle="collapse" type="button"> <span class="sr-only"> Toggle navigation </span> <span class="icon-bar"> </span> <span class="icon-bar"> </span> <span class="icon-bar"> </span> </button> <div class="brand-wrapper"> <a class="navbar-brand" href="/"> </a> </div> </div>  <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> <ul class="nav navbar-nav navbar-main show"> <li class="search-container-mobile"> <div class="openstack-search-bar" data-baseurl="search.openstack.org" data-context="docs-openstack"> </div> </li> <li> <a class="drop" href="https://www.openstack.org/software/" id="dropdownMenuSoftware"> Software <i class="fa fa-caret-down"> </i> </a> <i class="mobile-expand"> </i> <ul aria-labelledby="dropdownMenuSoftware" class="dropdown-menu dropdown-hover" role="menu"> <li role="presentation"> <a href="https://www.openstack.org/software/" role="menuitem" tabindex="-1"> Overview </a> </li> <li role="presentation"> <a href="https://www.openstack.org/software/project-navigator/openstack-components" role="menuitem" tabindex="-1"> Project Navigator </a> </li> <li role="presentation"> <a href="https://www.openstack.org/software/sample-configs/" role="menuitem" tabindex="-1"> Sample Configs </a> </li> <li class="divider" role="presentation"> </li> <li role="presentation"> <a href="https://www.openstack.org/software/security/" role="menuitem" tabindex="-1"> Security </a> </li> <li role="presentation"> <a href="https://www.openstack.org/software/start/" role="menuitem" tabindex="-1"> Get Started </a> </li> <li role="presentation"> <a href="https://www.openstack.org/software/roadmap/" role="menuitem" tabindex="-1"> Roadmap </a> </li> <li role="presentation"> <a href="https://www.openstack.org/software/latest-release/" role="menuitem" tabindex="-1"> Latest Release </a> </li> <li role="presentation"> <a href="https://www.openstack.org/software/sourcecode/" role="menuitem" tabindex="-1"> Source Code </a> </li> </ul> </li> <li> <a class="drop" href="https://www.openstack.org/user-stories/" id="dropdownMenuUsers"> Users <i class="fa fa-caret-down"> </i> </a> <i class="mobile-expand"> </i> <ul aria-labelledby="dropdownMenuUsers" class="dropdown-menu dropdown-hover" role="menu"> <li role="presentation"> <a href="https://www.openstack.org/user-stories/" role="menuitem" tabindex="-1"> Overview </a> </li> <li class="divider" role="presentation"> </li> <li role="presentation"> <a href="https://www.openstack.org/telecoms-and-nfv/" role="menuitem" tabindex="-1"> Telecoms and NFV </a> </li> <li role="presentation"> <a href="https://www.openstack.org/enterprise/" role="menuitem" tabindex="-1"> OpenStack in the Enterprise </a> </li> <li role="presentation"> <a href="https://www.openstack.org/appdev/" role="menuitem" tabindex="-1"> Application Developers & ISVs </a> </li> <li role="presentation"> <a href="//superuser.openstack.org/" role="menuitem" tabindex="-1"> Superuser Magazine </a> </li> <li role="presentation"> <a href="https://www.openstack.org/surveys/landing" role="menuitem" tabindex="-1"> User Survey </a> </li> </ul> </li> <li> <a class="drop" href="https://www.openstack.org/community/" id="dropdownMenuCommunity"> Community <i class="fa fa-caret-down"> </i> </a> <i class="mobile-expand"> </i> <ul aria-labelledby="dropdownMenuCommunity" class="dropdown-menu dropdown-hover" role="menu"> <li role="presentation"> <a href="https://www.openstack.org/community/" role="menuitem" tabindex="-1"> Welcome! Start Here </a> </li> <li role="presentation"> <a href="https://openinfra.dev" role="menuitem" tabindex="-1"> OpenInfra Foundation </a> </li> <li role="presentation"> <a href="https://wiki.openstack.org" role="menuitem" tabindex="-1"> OpenStack Wiki </a> </li> <li role="presentation"> <a href="https://groups.openstack.org" role="menuitem" tabindex="-1"> User Groups </a> </li> <li role="presentation"> <a href="https://www.openstack.org/community/speakers/" role="menuitem" tabindex="-1"> Speakers Bureau </a> </li> <li class="divider" role="presentation"> </li> <li role="presentation"> <a href="https://www.openstack.org/foundation/companies/" role="menuitem" tabindex="-1"> Supporting Companies </a> </li> <li role="presentation"> <a href="https://www.openstack.org/community/jobs/" role="menuitem" tabindex="-1"> Jobs </a> </li> <li class="divider" role="presentation"> </li> <li role="presentation"> <a href="https://openinfra.dev/join/" role="menuitem" tabindex="-1"> Join The Community </a> </li> </ul> </li> <li> <a href="https://www.openstack.org/marketplace/"> Marketplace </a> </li> <li> <a class="drop" href="https://openinfra.dev/summit" id="dropdownMenuEvents"> Events <i class="fa fa-caret-down"> </i> </a> <i class="mobile-expand"> </i> <ul aria-labelledby="dropdownMenuEvents" class="dropdown-menu dropdown-hover" role="menu"> <li role="presentation"> <a href="https://www.openstack.org/community/events/" role="menuitem" tabindex="-1"> Overview </a> </li> <li role="presentation"> <a href="https://openinfra.dev/summit" role="menuitem" tabindex="-1"> OpenInfra Summit </a> </li> <li role="presentation"> <a href="https://www.openstack.org/community/events/openstackdays" role="menuitem" tabindex="-1"> OpenStack Days </a> </li> </ul> </li> <li> <a class="drop" href="https://www.openstack.org/learn/" id="dropdownMenuLearn"> Learn <i class="fa fa-caret-down"> </i> </a> <i class="mobile-expand"> </i> <ul aria-labelledby="dropdownMenuEvents" class="dropdown-menu dropdown-hover" role="menu"> <li role="presentation"> <a href="https://www.openstack.org/marketplace/training/" role="menuitem" tabindex="-1"> Training </a> </li> <li role="presentation"> <a href="https://www.openstack.org/coa/" role="menuitem" tabindex="-1"> Get Certified </a> </li> <li role="presentation"> <a href="//superuser.openstack.org" role="menuitem" tabindex="-1"> Superuser Magazine </a> </li> <li role="presentation"> <a href="https://www.openstack.org/videos/" role="menuitem" tabindex="-1"> Summit Videos </a> </li> <li role="presentation"> <a href="https://www.openstack.org/analysts/" role="menuitem" tabindex="-1"> Analyst Reports </a> </li> <li role="presentation"> <a href="https://www.openstack.org/news/" role="menuitem" tabindex="-1"> News </a> </li> <li role="presentation"> <a href="https://www.openstack.org/blog/" role="menuitem" tabindex="-1"> Blog </a> </li> </ul> </li> <li> <a href="https://docs.openstack.org/"> Docs </a> </li> <li> </li> <li> </li> <li class="join-nav-section"> <a href="#" id="dropdownMenuJoin"> Join <i class="fa fa-caret-down"> </i> </a> <ul aria-labelledby="dropdownMenuJoin" class="dropdown-menu dropdown-hover" role="menu" style="display: none;"> <li role="presentation"> <a href="https://openinfra.dev/join" role="menuitem" tabindex="-1"> Sign up for Foundation Membership </a> </li> <li role="presentation"> <a href="https://openinfra.dev/" role="menuitem" tabindex="-1"> More about the Foundation </a> </li> </ul> </li> <li> <a class="sign-in-btn" href="https://www.openstack.org/Security/login/"> Log In </a> </li> </ul> </div>  </div>  </nav>  <div class="top-docs-wrapper"> <div class="container"> <div class="row"> <div class="col-lg-8 col-md-8 col-sm-8"> <h1> OpenStack Ocata API Reference Documentation </h1> <p> This page contains documentation about the OpenStack API and how to use it. </p> </div> </div> </div> <div class="mid-docs-wrapper" id="docs-main-body"> <div class="container"> <div class="row"> <div class="col-lg-12"> </div> </div> <div class="row docs-toc"> <div class="col-lg-6 col-md-6 col-sm-6"> <div class="docs-link-sections"> <h3> <i class="fa fa-book"> </i> API References </h3> Application Catalog service (murano): <a href="https://docs.openstack.org/api-ref/application-catalog/"> API Reference </a> <br/> Bare Metal service (ironic): <a href="https://docs.openstack.org/api-ref/baremetal/"> API Reference </a> <br/> Block Storage service (cinder): <a href="https://docs.openstack.org/api-ref/block-storage/"> API Reference </a> <br/> Clustering service (senlin): <a href="https://docs.openstack.org/api-ref/clustering/"> API Reference </a> <br/> Compute service (nova): <a href="https://docs.openstack.org/api-ref/compute/"> API Reference </a> <a href="https://docs.openstack.org/api-guide/compute/"> API Guide </a> <br/> Container Infrastructure Management service (magnum): <a href="https://docs.openstack.org/api-ref/container-infrastructure-management/"> API Reference </a> <br/> Data Processing service (sahara): <a href="https://docs.openstack.org/api-ref/data-processing/"> API Reference </a> <br/> Data Protection Orchestration Service (karbor): <a href="https://docs.openstack.org/api-ref/data-protection-orchestration/"> API Reference </a> <br/> Database service (trove): <a href="https://docs.openstack.org/api-ref/database/"> API Reference </a> <br/> DNS service (designate): <a href="https://docs.openstack.org/api-ref/dns/"> API Reference </a> <br/> Identity service (keystone): <a href="https://docs.openstack.org/api-ref/identity/"> API Reference </a> <br/> Image service (glance): <a href="https://docs.openstack.org/api-ref/image/"> API Reference </a> <br/> Key Manager service (barbican): <a href="https://docs.openstack.org/api-ref/key-manager/"> API Reference </a> <a href="https://docs.openstack.org/api-guide/key-manager/"> API Guide </a> <br/> Load-balancer service (octavia): <a href="https://docs.openstack.org/api-ref/load-balancer/"> API Reference </a> <br/> Messaging service (zaqar): <a href="https://docs.openstack.org/api-ref/message/"> API Reference </a> <br/> Networking service (neutron): <a href="https://docs.openstack.org/api-ref/network/"> API Reference </a> <br/> NFV Orchestration service (tacker): <a href="https://docs.openstack.org/api-ref/nfv-orchestration/"> API Reference </a> <br/> Object Storage service (swift): <a href="https://docs.openstack.org/api-ref/object-store/"> API Reference </a> <br/> Orchestration service (heat): <a href="https://docs.openstack.org/api-ref/orchestration/"> API Reference </a> <a href="/heat/ocata/api/"> API Guide </a> <br/> Search service (searchlight): <a href="https://docs.openstack.org/api-ref/search/"> API Reference </a> <br/> Shared File Systems service (manila): <a href="https://docs.openstack.org/api-ref/shared-file-system/"> API Reference </a> <br/> </div> </div> <div class="col-lg-6 col-md-6 col-sm-6"> <div class="docs-link-sections"> <h3> <i class="fa fa-cloud"> </i> User Guides </h3> <a href="/api-quick-start/"> API Guide </a> <br/> <a href="https://developer.openstack.org"> Open source software for application development </a> <br/> </div> </div> </div> <div class="row docs-contribute-wrapper"> <div class="col-lg-12"> <p> Documentation treated like code, powered by the community - interested? </p> <a class="overview-btn contribute-btn" href="/doc-contrib-guide/"> How To Contribute <i class="fa fa-chevron-right"> </i> </a> </div> </div> </div> </div>   <link href="https://docs.openstack.org/common/css/deprecated-badge.css" rel="stylesheet"/> <script src="https://docs.openstack.org/common/js/deprecated-badge.js"> </script> <div class="deprecated-badge fixed deprecated-badge-eol" id="deprecated-badge"> <span class="deprecated-badge-close-button" id="deprecated-badge-close-button" title="close"> x </span> <div class="container"> <div class="col-lg-12 col-md-12 col-sm-12"> <p> Currently viewing </p> <div class="dropdown docs-dropdown"> <a data-toggle="dropdown" href="#"> Ocata <i class="fa fa-caret-down fa-3"> </i> </a> <ul aria-labelledby="dLabel" class="dropdown-menu" role="menu"> <li role="presentation"> <a href="https://docs.openstack.org/2025.1/api/index.html" role="menuitem" tabindex="-1"> 2025.1 (in development) </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/2024.2/api/index.html" role="menuitem" tabindex="-1"> 2024.2 (current release) </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/2024.1/api/index.html" role="menuitem" tabindex="-1"> 2024.1 </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/2023.2/api/index.html" role="menuitem" tabindex="-1"> 2023.2 </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/2023.1/api/index.html" role="menuitem" tabindex="-1"> 2023.1 </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/zed/api/index.html" role="menuitem" tabindex="-1"> Zed </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/yoga/api/index.html" role="menuitem" tabindex="-1"> Yoga </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/xena/api/index.html" role="menuitem" tabindex="-1"> Xena </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/wallaby/api/index.html" role="menuitem" tabindex="-1"> Wallaby </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/victoria/api/index.html" role="menuitem" tabindex="-1"> Victoria </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/ussuri/api/index.html" role="menuitem" tabindex="-1"> Ussuri </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/train/api/index.html" role="menuitem" tabindex="-1"> Train </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/stein/api/index.html" role="menuitem" tabindex="-1"> Stein </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/rocky/api/index.html" role="menuitem" tabindex="-1"> Rocky </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/queens/api/index.html" role="menuitem" tabindex="-1"> Queens </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/pike/api/index.html" role="menuitem" tabindex="-1"> Pike </a> </li> <li class="current" role="presentation"> Ocata (viewing) </li> <li role="presentation"> <a href="https://docs.openstack.org/newton/api/index.html" role="menuitem" tabindex="-1"> Newton </a> </li> <li role="presentation"> <a href="https://docs.openstack.org/mitaka/api/index.html" role="menuitem" tabindex="-1"> Mitaka </a> </li> </ul> </div> <p> which is no longer supported by the community. The current supported release is <a href="/2024.2/"> 2024.2. </a> </p> <a class="deprecated-badge-right" href="#top"> <i aria-hidden="true" class="fa fa-chevron-up"> </i> Back to Top </a> </div> </div> </div>  <footer> <div class="container"> <div class="row footer-links"> <div class="col-lg-2 col-sm-2"> <h3> OpenStack </h3> <ul> <li> <a href="https://www.openstack.org/projects/"> Projects </a> </li> <li> <a href="https://www.openstack.org/software/security/"> OpenStack Security </a> </li> <li> <a href="https://www.openstack.org/projects/openstack-faq/"> Common Questions </a> </li> <li> <a href="https://www.openstack.org/blog/"> Blog </a> </li> <li> <a href="https://www.openstack.org/news/"> News </a> </li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3> Community </h3> <ul> <li> <a href="https://www.openstack.org/community/"> User Groups </a> </li> <li> <a href="https://www.openstack.org/community/events/"> Events </a> </li> <li> <a href="https://www.openstack.org/community/jobs/"> Jobs </a> </li> <li> <a href="https://www.openstack.org/foundation/companies/"> Companies </a> </li> <li> <a href="/contributors"> Contribute </a> </li> <li> <a href="https://www.openstack.org/store"> Get Swag! </a> </li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3> Documentation </h3> <ul> <li> <a href="https://docs.openstack.org"> OpenStack Manuals </a> </li> <li> <a href="https://www.openstack.org/software/start/"> Getting Started </a> </li> <li> <a href="https://developer.openstack.org"> API Documentation </a> </li> <li> <a href="https://wiki.openstack.org"> Wiki </a> </li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3> Branding & Legal </h3> <ul> <li> <a href="https://www.openstack.org/brand/"> Logos & Guidelines </a> </li> <li> <a href="https://www.openstack.org/brand/openstack-trademark-policy/"> Trademark Policy </a> </li> <li> <a href="https://www.openstack.org/privacy/"> Privacy Policy </a> </li> <li> <a href="https://wiki.openstack.org/wiki/How_To_Contribute#Contributor_License_Agreement"> OpenStack CLA </a> </li> </ul> </div> <div class="col-lg-4 col-sm-4"> <h3> Stay In Touch </h3> <a class="social-icons footer-twitter" href="https://twitter.com/OpenStack" target="_blank"> </a> <a class="social-icons footer-facebook" href="https://www.facebook.com/openstack" target="_blank"> </a> <a class="social-icons footer-linkedin" href="https://www.linkedin.com/company/openstack" target="_blank"> </a> <a class="social-icons footer-youtube" href="https://www.youtube.com/user/OpenStackFoundation" target="_blank"> </a>  <p class="fine-print"> The OpenStack project is provided under the Apache 2.0 license. Openstack.org is powered by <a href="https://vexxhost.com" target="_blank"> VEXXHOST </a> . </p> </div> </div> </div> </footer>  <script src="https://docs.openstack.org/common/js/jquery-3.1.1.js" type="text/javascript"> </script>  <script src="https://docs.openstack.org/common/js/bootstrap.js" type="text/javascript"> </script>  <script src="https://docs.openstack.org/common/js/navigation.js" type="text/javascript"> </script>  <script src="https://docs.openstack.org/common/js/docs.js" type="text/javascript"> </script>  <script src="https://docs.openstack.org/common/js/webui-popover.js" type="text/javascript"> </script>  <script type="text/javascript"> // Change character image on refresh // Add file names and captions to doc-characters.json $.getJSON("https://docs.openstack.org/common/js//doc-characters.json", function(data) { var item = data.images[Math.floor(Math.random()*data.images.length)]; $('<img src="https://docs.openstack.org/common/js/../images/docs/' + item.image + '">').appendTo('#superuser-img'); $('<p>' + item.caption + '<strong>OpenStack Operator</strong></p>').appendTo('#superuser-img'); }); </script> </div> </body> </html>

CINXE.COM

OpenStack Docs: API references