The Abiquo API

The Abiquo API offers all of the operations of the cloud management platform through a complete RESTful API with navigable hyperlinks, see Basic Behaviors. The Get Started section introduces the Abiquo platform and the User Guide to the Abiquo GUI describes its operation. After you are familiar with the platform works, you are ready to Get Started with the Abiquo API

Index of API Resources

Tip: click on the column header to sort the table by that column.

Abiquo Main Resource URI	Resource Wiki Page Link
/admin/rules	AllocationRulesResource
/admin/rules/datastoreloadlevel	AllocationRulesResource
/admin/rules/datastoreloadlevel/{loadlevel}	AllocationRulesResource
/admin/rules/enterpriseExclusions	AllocationRulesResource
/admin/rules/enterpriseExclusions/{enterpriseExclusion}	AllocationRulesResource
/admin/rules/fitsPolicy	AllocationRulesResource
/admin/rules/fitsPolicy/{fitPolicy}	AllocationRulesResource
/admin/rules/machineLoadLevel	AllocationRulesResource
/admin/rules/machineLoadLevel/{loadLevel}	AllocationRulesResource
/cloud/virtualmachines	AllVirtualMachinesResource
/cloud/location/{id}/availabilityzones	AvailabilityZoneResource
/admin/datacenters/{datacenter}/backupproperties	BackupDatacenterPropertiesResource
/admin/datacenters/{datacenter}/backupmanager	BackupManagerResource
/config/backupplugintypes	BackupPluginTypesResource
/admin/datacenters/{datacenter}/backuppolicies	BackupPolicyResource
/admin/datacenters/{datacenter}/backuppolicies/{backuppolicy}	BackupPolicyResource
/config/backuptypes	BackupTypesResource
/config/categories	CategoryResource
/config/categories/{category}	CategoryResource
/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}/disks/{disk}/conversions	ConversionResource
/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}/disks/{disk}/conversions/{conversion}	ConversionResource
/config/costcodes	CostCodeResource
/config/costcodes/{costcode}	CostCodeResource
/config/currencies	CurrencyResource
/config/currencies/{currency}	CurrencyResource
/admin/enterprises/{enterprise}/limits	DatacenterLimitsResource
/admin/enterprises/{enterprise}/datacenterrepositories	DatacenterRepositoryResource
/admin/datacenters	DatacenterResource
/admin/datacenters/{datacenter}	DatacenterResource
/admin/datacenters/{datacenter}/action/getlimits	DatacenterResource
/admin/datacenters/{datacenter}/datastoretiers	DatastoreTierResource
/api/cloud/locations/{location}/devices/{device}/networks	DeviceNetworksResource
/api/cloud/locations/{location}/devices/{device}/networks/{network}	DeviceNetworksResource
/cloud/locations/{locationId}/	DeviceResource
/cloud/locations/{locationId}/devices	DeviceResource
/config/devicetypes	DeviceTypesResource
/config/devicetypes/{devicetype}	DeviceTypesResource
/config/diskcontrollertypes	DiskControllerTypeResource
/config/diskcontrollertypes/{diskcontrollertype}	DiskControllerTypeResource
/config/diskformattypes	DiskFormatTypesResource
/config/diskformattypes/{diskformattype}	DiskFormatTypesResource
/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}/disks	DisksResource
/admin/enterprises/{enterprise}/properties	EnterprisePropertiesResource
/admin/enterprises	EnterpriseResource
/admin/enterprises/{enterprise}	EnterpriseResource
/config/ethernetdrivertypes	EthernetDriverType Resource
/config/ethernetdrivertypes/{ethernetdrivertype}	EthernetDriverType Resource
/events	EventsResource
/admin/datacenters/{datacenter}/excludednetworks	ExcludedNetworkResource
/admin/enterprises/{enterprise}/limits/{limit}/externalnetworks	ExternalNetworksResource
/admin/enterprises/{enterprise}/limits/{limit}/externalnetworks/action/default	ExternalNetworksResource
/admin/enterprises/{enterprise}/limits/{limit}/externalnetworks/{externalnetwork}	ExternalNetworksResource
/cloud/locations/{location}/device/{device}/firewalls	FirewallPoliciesResource
/cloud/locations/{location}/devices/{device}/firewalls/{firewall}/rules	FirewallRulesResource
/cloud/virtualdatacenters/{virtualdatacenter}/disks	HardDiskResource
/cloud/virtualdatacenters/{virtualdatacenter}/disks/{disk}	HardDiskResource
/admin/datacenters/{datacenter}/hardwareprofiles	HardwareProfileResource
/admin/datacenters/{datacenter}/hardwareprofiles/{hardwareprofile}	HardwareProfileResource
/admin/datacenters/{publiccloudregion}/hardwareprofiles	HardwareProfileResource
/admin/publiccloudregions/{publiccloudregion}/hardwareprofiles/{hardwareprofile}	HardwareProfileResource
/config/hypervisortypes	HypervisorTypeResource
/cloud/locations/{id}/ips	IPsResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/layers	LayersResource
/config/licenses	LicenseResource
/cloud/locations/{location}/devices/{device}/loadbalancers	LoadBalancerResource
/cloud/locations	LocationsResource
/login	LoginResource
/admin/datacenters/{datacenter}/racks/{rack}/machines/{machine}/datastores	MachineDatastoresResource
/admin/datacenters/{datacenter}/racks/{rack}/machines	MachineResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualapplince}/virtualmachines/{virtualmachine}/metrics/{metric}/alarms	MetricAlarmResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualapplince}/virtualmachines/{virtualmachine}/metrics/{metric}/alarms/{alarm}	MetricAlarmResource
/admin/datacenters/{datacenter}/networkservicetypes	NetworkServiceTypeResource
/config/ostypes	OSType Resource
/config/ostypes/{ostype}	OSType Resource
/config/pricingtemplates	PricingTemplateResource
/cloud/virtualdatacenters/{virtualdatacenter}/privatenetworks	PrivateNetworksResource
/cloud/virtualdatacenters/{virtualdatacenter}/privatenetworks/{privatenetwork}/ips	PrivateNetworksResource
/config/privileges	PrivilegeResource
/admin/enterprises/{enterprise}/credentials	PublicCloudCredentialsResource
/admin/publiccloudregions	PublicCloudRegionResource
/admin/datacenters/{datacenter}/network/{publicnetwork}/ips	PublicIpResource
/admin/datacenters/{datacenter}/network	PublicNetworkResource
/admin/datacenters/{datacenter}/racks	RackResource
/admin/datacenters/{datacenter}/remoteservices	RemoteServiceResource
/admin/publiccloudregions/{publiccloudregion}/remoteservices	RemoteServiceResourceForRegions
/admin/remoteservices	Remote Services Resource
/admin/enterprises/{enterprise}/reservedmachines	ReservedMachinesResource
/admin/rolesldap	RolesLDAPResource
/admin/roles	RolesResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/scalingroups/{scalinggroup}	ScalingGroupResource
/admin/scopes	Scopes Resource
/login/sessions	SessionResource
/cloud/locations/{location}/devices/{device}/sslcertificates	SSLCertificatesResource
/statistics	StatisticsResource
/statistics/cloudusage	StatisticsResource
/statistics/enterpriseresources	StatisticsResource
/statistics/vappsresources	StatisticsResource
/statistics/vdcsresources	StatisticsResource
/admin/datacenters/{datacenter}/storage/devices	StorageDeviceResource
/admin/datacenters/{datacenter}/storage/devices/{device}/pools	StoragePoolResource
/config/properties	SystemPropertyResource
/admin/enterprises/{enterprise}/appslib/templateDefinitionLists	TemplateDefinitionListResource
/admin/enterprises/{enterprise}/appslib/templateDefinitions	TemplateDefinitionResource
/admin/datacenters/{datacenter}/storage/tiers	TierResource
/admin/enterprises/{enterprise}/users	UserResource
/version	VersionResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances	VirtualApplianceResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}	VirtualApplianceResource
/admin/enterprises/{enterprise}/vappspecs/{spec}	VirtualApplianceSpecResource
/enterprises/{enterprise}/vappspecs	VirtualApplianceSpecResource
/cloud/virtualdatacenters	VirtualDatacenterResource
/cloud/virtualdatacenters/{virtualdatacenter}	VirtualDatacenterResource
/cloud/virtualdatacenters/{virtualdatacenter}/tiers	VirtualDatacenterTiersResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualapplince}/virtualmachines/{virtualmachine}/actionplans	VirtualMachineActionPlanResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualapplince}/virtualmachines/{virtualmachine}/actionplans/{actionplan}/schedules	VirtualMachineActionPlanSchedulesResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/backup/	VirtualMachineBackupResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/config/runlist	VirtualMachineChefRunlistResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/network	VirtualMachineConfigurationResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/storage	VirtualMachineConfigurationResource
/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines	VirtualMachineResource
/admin/virtualmachines	VirtualMachinesAdminResource
/admin/datacenters/{datacenter}/racks/{rack}/machines/{machine}/virtualmachines	VirtualMachinesFromInfrastructureResource
/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates	VirtualMachineTemplateResource
/cloud/virtualdatacenters/{virtualdatacenter}/volumes	VolumeResource
/cloud/virtualdatacenters/{virtualdatacenter}/volumes/{volume}	VolumeResource