<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 20. CloudStack API</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css" /><link rel="stylesheet" media="print" href="Common_Content/css/print.css" type="text/css" /><meta name="generator" content="publican 2.8" /><meta name="package" content="Apache_CloudStack-Admin_Guide-4.2.0-en-US-1-" /><script type="text/javascript" src="../../../../../toc.js"></script><script type="text/javascript">
              addID('Apache_CloudStack');
              
	      addID('Apache_CloudStack.4.2.0');
              
              addID('Apache_CloudStack.4.2.0.books');
	      addID('Apache_CloudStack.4.2.0.Admin_Guide');
              </script><link rel="home" href="index.html" title="CloudStack Administrator's Guide" /><link rel="up" href="index.html" title="CloudStack Administrator's Guide" /><link rel="prev" href="granular-param.html" title="19.4. Granular Global Configuration Parameters" /><link rel="next" href="provisioning-auth-api.html" title="20.1. Provisioning and Authentication API" /></head><body class="toc_embeded "><div id="tocdiv" class="toc"><iframe id="tocframe" class="toc" src="../../../../toc.html">This is an iframe, to view it upgrade your browser or enable iframe display.</iframe></div><p id="title"><a class="left" href="http://cloudstack.apache.org"><img src="Common_Content/images/image_left.png" alt="Product Site" /></a><a class="right" href="http://cloudstack.apache.org/docs"><img src="Common_Content/images/image_right.png" alt="Documentation Site" /></a></p><ul class="docnav"><li class="previous"><a accesskey="p" href="granular-param.html"><strong>Prev</strong></a></li><li class="next"><a accesskey="n" href="provisioning-auth-api.html"><strong>Next</strong></a></li></ul><div xml:lang="en-US" class="chapter" id="api-overview" lang="en-US"><div class="titlepage"><div><div><h1 class="title">Chapter 20. CloudStack API</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="section"><a href="provisioning-auth-api.html">20.1. Provisioning and Authentication API</a></span></dt><dt><span class="section"><a href="allocators.html">20.2. Allocators</a></span></dt><dt><span class="section"><a href="user-data-and-meta-data.html">20.3. User Data and Meta Data</a></span></dt></dl></div><div class="para">
		The CloudStack API is a low level API that has been used to implement the CloudStack web UIs. It is also a good basis for implementing other popular APIs such as EC2/S3 and emerging DMTF standards.
	</div><div class="para">
		Many CloudStack API calls are asynchronous. These will return a Job ID immediately when called. This Job ID can be used to query the status of the job later. Also, status calls on impacted resources will provide some indication of their state.
	</div><div class="para">
		The API has a REST-like query basis and returns results in XML or JSON.
	</div><div class="para">
		See <a href="http://docs.cloudstack.org/CloudStack_Documentation/Developer's_Guide%3A_CloudStack">the Developer’s Guide</a> and <a href="http://docs.cloudstack.org/CloudStack_Documentation/API_Reference%3A_CloudStack">the API Reference</a>.
	</div></div><ul class="docnav"><li class="previous"><a accesskey="p" href="granular-param.html"><strong>Prev</strong>19.4. Granular Global Configuration Parameters</a></li><li class="up"><a accesskey="u" href="#"><strong>Up</strong></a></li><li class="home"><a accesskey="h" href="index.html"><strong>Home</strong></a></li><li class="next"><a accesskey="n" href="provisioning-auth-api.html"><strong>Next</strong>20.1. Provisioning and Authentication API</a></li></ul></body></html>
