API Changelog v3.4

Owned by MS (Unlicensed)
May 03, 2022
2 min read

Abiquo API Changes

Abiquo is committed to maintaining backwards compatibility for 2 minor releases. If for some reason, backwards compatibility were not possible to maintain, Abiquo would detail the changes in the API Changelog. For example, Abiquo 3.4 should be compatible with 3.2 and 3.0. The best practice to ensure compatibility is to use the version number in the header of your API request with the media type and content type.

For major versions such as 3.0, Abiquo will make a best effort to maintain compatibility with at least the previous version, in the case of 3.0 this would be 2.6. Abiquo will provide details of any changes in the API Changelog. 

Abiquo API 3.4 Changelog

The Abiquo 3.4 API will include support for virtual machine templates with multiple disks.

There are several changes in the media types and endpoints in order to support the ability to define more than a single disk for each template.

The following attributes have been removed from the VirtualMachineTemplate data model:

  • path
  • diskFormatType
  • diskFileSize
  • hdRequired
  • diskControllerType and diskController
  • conversion links

They have been moved to a new child entity called Disk.

The Disk entity also contains:

  • sequence
  • label 
  • creationDate

The ConversionResource now its a child of disk. So the endpoint in Abiquo 3.2 is:

  • virtualmachinetemplates/x/conversions

And in Abiquo 3.4, this has been changed to:

  • virtualmachinetemplates/x/disks/y/conversions

New configuration resources have been added at: 

  • config/diskcontrollertypes
  • config/ethernetdrivertypes
  • config/ostypes

Perform GET requests to these resources to determine the allowed values when editing disks and virtual machine templates.

Changes to resources and methods

New resources

Disk Resource
  • GET, PUT, DELETE 
  • POST action/deletefile
  • GET task and tasks
Disks Resource
  • GET - not paginated
  • POST - create empty disk (consumes and produces Disk)
  • POST - copyDisk (consumes DiskRequest produces AcceptedRequest)

Changed resources

VirtualMachineTemplate

Changed methods:

  • POST promote -> select disks -> no instance restriction (copy or promote)
  • POST VirtualMachineTemplatePersistent -> Accepted -> select disks

New query parameters:

  • plugin - when the source query parameter is used to retrieve REMOTE templates, you can specify the plugin used to retrieve the templates (e.g. DOCKER)

  • external
  • false
  • master
AllowedLocationTemplatesResource

When you retrieve all templates in enterprise repository of allowed datacenters, the following query parameters have been added:

  • states
  • hypervisorTypeName
  • virtualdatacenter
  • external

See VirtualMachineTemplateResource#Retrieveallvirtualmachinetemplates

VirtualDatacenter Resource

When you retrieve a list of available virtual machine templates, the following query parameters have been added:

  • states
  • external
  • master

See VirtualDatacenterResource#Retrievealistofavailablevirtualmachinetemplates

VirtualMachine Resource
  • When creating an instance you can supply links to selected disks

See VirtualMachineResource#InstanceaVirtualMachine

Copyright © 2006-2022, Abiquo Holdings SL. All rights reserved