Abiquo 2.6

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

 

This document describes the resources available in the Abiquo API. We use the standard Service document that Atom Publishing Protocol provides to represent these resources.

Get the root exposed resources.

The first call you could perform in the API would be one that retrieves all the root exposed resources to start auto-discovering the api.

Retrieve the root resources

REQUEST
Synopsis: GET http://example.com/api/
Roles needed: ROLE_AUTHENTICATED (Check out role definitions here)
Request Headers: Accept("application/atomsvc+xml")
Request Parameters: N/A.
Request Message Body: N/A.
Request Example:

Code Block
titleGet the list of root resources
%curl --verbose -X GET http://example.com/api -u admin:xabiquo -H 'Accept:application/atomsvc+xml' | xmlindent -nbe -f

> GET /api HTTP/1.1
> Authorization: Basic YWRtaW46eGFiaXF1bw==
> User-Agent: curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3
> Host: example.com
> Accept:application/atomsvc+xml
> 
< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Set-Cookie: auth=YWRtaW46MTM4MjM1MDU4MzU0Njo2MDY0OWQ1NmJjNzBlMjA0N2NlODllMjI3N2ZhYmUyMjpBQklRVU8; Expires=Mon, 21-Oct-2013 10:16:23 GMT; Path=/api
< Set-Cookie: JSESSIONID=47C2C783833A634353E8D35774457EA9; Path=/api
< Content-Type: application/atomsvc+xml
< Content-Length: 5588
< Date: Mon, 21 Oct 2013 09:46:23 GMT
< 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:service xmlns="http://www.w3.org/2005/Atom" xmlns:ns2="http://www.w3.org/2007/app" xmlns:ns3="http://a9.com/-/spec/opensearch/1.1/" xmlns:ns4="http://www.w3.org/1999/xhtml">
    <ns2:workspace>
        <title>Abiquo administration workspace</title>
        <ns2:collection href="http://example.com:80/api/admin/rules">
            <title>AllocationRules</title>
            <ns2:accept>application/vnd.abiquo.rules+xml;version=2.6</ns2:accept>
            <ns2:accept>application/vnd.abiquo.rules+json</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/admin/datacenters">
            <title>Datacenters</title>
            <ns2:accept>application/vnd.abiquo.datacenter+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.publicdatacenter+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.publicdatacenter+xml;version=2.6</ns2:accept>
            <ns2:accept>application/vnd.abiquo.datacenter+xml;version=2.6</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/admin/enterprises">
            <title>Enterprises</title>
            <ns2:accept>application/vnd.abiquo.enterprise+xml;version=2.6</ns2:accept>
            <ns2:accept>application/vnd.abiquo.enterprise+json</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/events">
            <title>Events</title>
            <ns2:accept/>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/admin/roles">
            <title>Roles</title>
            <ns2:accept>application/vnd.abiquo.rolewithldap+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.rolewithldap+xml;version=2.6</ns2:accept>
            <ns2:accept>application/vnd.abiquo.role+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.role+xml;version=2.6</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/admin/rolesldap">
            <title>Roles Ldap</title>
            <ns2:accept>application/vnd.abiquo.roleldap+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.roleldap+xml;version=2.6</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/admin/scopes">
            <title>Scopes</title>
            <ns2:accept>application/vnd.abiquo.scope+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.scope+xml;version=2.6</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/admin/statistics">
            <title>Statistics</title>
            <ns2:accept/>
        </ns2:collection>
    </ns2:workspace>
    <ns2:workspace>
        <title>Abiquo cloud workspace</title>
        <ns2:collection href="http://example.com:80/api/cloud/virtualdatacenters">
            <title>VirtualDatacenters</title>
            <ns2:accept>application/vnd.abiquo.virtualdatacenter+xml;version=2.6</ns2:accept>
            <ns2:accept>application/vnd.abiquo.virtualdatacenter+json</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/cloud/virtualmachines">
            <title>VirtualMachines</title>
            <ns2:accept/>
        </ns2:collection>
    </ns2:workspace>
    <ns2:workspace>
        <title>Abiquo configuration workspace</title>
        <ns2:collection href="http://example.com:80/api/config/backups">
            <title>Backups</title>
            <ns2:accept/>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/categories">
            <title>Categories</title>
            <ns2:accept>application/vnd.abiquo.category+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.category+xml;version=2.6</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/costcodes">
            <title>CostCodes</title>
            <ns2:accept>application/vnd.abiquo.costcode+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.costcode+xml;version=2.6</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/currencies">
            <title>Currencies</title>
            <ns2:accept>application/vnd.abiquo.currency+xml;version=2.6</ns2:accept>
            <ns2:accept>application/vnd.abiquo.currency+json</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/diskformattypes">
            <title>DiskFormatTypes</title>
            <ns2:accept/>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/hypervisortypes">
            <title>HypervisorTypes</title>
            <ns2:accept/>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/licenses">
            <title>Licenses</title>
            <ns2:accept>application/vnd.abiquo.license+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.license+xml;version=2.6</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/pricingtemplates">
            <title>PricingTemplates</title>
            <ns2:accept>application/vnd.abiquo.pricingtemplate+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.pricingtemplate+xml;version=2.6</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/privileges">
            <title>Privileges</title>
            <ns2:accept/>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/properties">
            <title>Properties</title>
            <ns2:accept>application/vnd.abiquo.systemproperty+json</ns2:accept>
            <ns2:accept>application/vnd.abiquo.systemproperty+xml;version=2.6</ns2:accept>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/providers">
            <title>Providers</title>
            <ns2:accept/>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/config/regions">
            <title>Regions</title>
            <ns2:accept/>
        </ns2:collection>
    </ns2:workspace>
    <ns2:workspace>
        <title>Abiquo login workspace</title>
        <ns2:collection href="http://example.com:80/api/login">
            <title>Login</title>
            <ns2:accept/>
        </ns2:collection>
    </ns2:workspace>
    <ns2:workspace>
        <title>Abiquo workspace</title>
        <ns2:collection href="http://example.com:80/api/version">
            <title>ApiVersion</title>
            <ns2:accept/>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/admin/statistics">
            <title>Statistics</title>
            <ns2:accept/>
        </ns2:collection>
        <ns2:collection href="http://example.com:80/api/statistics">
            <title>Statistics</title>
            <ns2:accept/>
        </ns2:collection>
    </ns2:workspace>
</ns2:service>


Div
classchildlist
Children Display
all
all