docs/en-US/api-overview.xml

<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
-->
<chapter id="api-overview">
  <title>&PRODUCT; API</title>
  <para>The &PRODUCT; API is a low level API that has been used to implement the &PRODUCT; web UIs.
    It is also a good basis for implementing other popular APIs such as EC2/S3 and emerging DMTF
    standards.</para>
  <para>Many &PRODUCT; 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.</para>
  <para>The API has a REST-like query basis and returns results in XML or JSON.</para>
  <para>See <ulink
      url="http://docs.cloudstack.org/CloudStack_Documentation/Developer's_Guide%3A_CloudStack">the
      Developer’s Guide</ulink> and <ulink
      url="http://docs.cloudstack.org/CloudStack_Documentation/API_Reference%3A_CloudStack">the API
      Reference</ulink>.</para>
  <xi:include href="provisioning-auth-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
  <xi:include href="allocators.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
  <xi:include href="user-data-and-meta-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter>