Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.

Abiquo 5.0

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  • Clients must provide a vendor-specific media type for each data entity, for example, if you wanted to send or retrieve an Abiquo tenant, you would use "application/vnd.abiquo.enterprise". 
    • If clients DO NOT supply a media type, the Abiquo API may return an error or an arbitrary media type (where more than one method uses the same URI and returns different media types)
  • Clients can use JSON or XML format for data, and this should be specified after the media type with "+json" or "+xml". If not specified, the "+json" default will be assumed
    • Do not try to convert from XML to JSON or vice versa.
  • Clients should also provide the version of the data entity (after the media type and the format), for example, "version=4.56"
    • If clients DO NOT supply the version of the data entity, the Abiquo API will use the MOST RECENT VERSION of a feature. We STRONGLY RECOMMEND that you always use versions to avoid problems on upgrades.
  • Clients should supply the media type of the data entity they are sending with the "Content-Type" header.
  • Clients should supply the media type they expect for the response in the "Accept" header. 
  • Example request headers

    Code Block
    titleExample Accept and Content type headers (POST and PUT requests)
    'Accept:application/vnd.abiquo.virtualmachine+json; version=4.46' 
    'Content-Type:application/vnd.abiquo.virtualmachine+json; version=4.46' 

    Code Block
    titleExample of Accept header (GET requests)
    'Accept:application/vnd.abiquo.virtualmachine+json; version=4.46' 

Request Parameters

Request parameters include paging parameters for collections of data entities, which are described in this section, and additional query parameters to filter and sort resource data, which are described in the API resource documentation.