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 4.4

Skip to end of metadata
Go to start of metadata

This table contains a list of common Abiquo tasks with their corresponding API resource URLs and links to API documentation. 

These links to the API are similar to the wiki links UI documentation in the Abiquo UI wikilinks help system. See Configuration View

 

Wiki link labelAPI URLAPI wiki link

Infrastructure

  
Infrastructureapi/admin 

Create datacenter

api/admin/datacentersDatacenterResource#Createadatacenter

Edit datacenter

api/admin/datacenters/{dc}DatacenterResource#Updateadatacenter
Manage remote servicesapi/admin/remoteservicesRemote Services Resource

Edit remote service in DC

api/admin/datacenters/{dc}/remoteservices/{rs}DatacenterResource#Updateadatacenter

Create physical machine

api/admin/datacenters/{dc}/action/discover
api/admin/datacenters/{dc}/machines

DatacenterResource#Listremotemachines
MachineResource#Createamachine

Manage datastores

api/admin/datacenters/{dc}/racks/{rk}/machines/{m}/datastores//action/refreshMachineDatastoresResource#Listdatastoresofamachine

Create rack

api/admin/datacenters/{dc}/racksRackResource#Createarack

Send email

api/admin/datacenters/{dc}/racks/{rk}/machines/{m}//action/sendmailMachineResource#Sendmail
Manage hardware profilesapi/admin/datacenters/{dc}/hardwareprofilesHardwareProfileResource

Create public VLAN

api/admin/datacenters/{dc}/networkPublicNetworkResource#Createapublicorexternalorunmanagednetwork
Create external VLANapi/admin/datacenters/{dc}/network
api/admin/enterprises/{ent}/limits/{limit}/externalnetworks/{extn}/ips

Access to create an external VLAN
PublicNetworkResource#Createapublicorexternalorunmanagednetwork
Access via Enterprise limits to retrieve external IPs for use in virtual datacenter
ExternalNetworksResource 

Create VLAN static routes

api/admin/datacenters/{dc}/network/{pubn}

Update the network to include DHCP option DTO
Abiquo Data Media Types#DhcpOptionMediaType
PublicNetworkResource#Updateapublic,external,orunmanagednetwork

Manage devices

/cloud/locations/{locationId}/devices

DeviceResource

Create storage device

api/admin/datacenters/{dc}/storage/devicesStorageDeviceResource#Createastoragedevice

Create storage pool

api/admin/datacenters/{dc}/storage/devices/{dev}/pools
api/admin/datacenters/{dc}/storage/tiers
api/admin/datacenters/{dc}/storage/devices/{dev}/pools

Retrieve pools from storage device
StoragePoolResource#Liststoragepools
Retrieve tiers in Abiquo
TierResource#Listtiers
Register pool and desired tier
StoragePoolResource#Createastoragepoolwithatierlink

Edit tier

api/admin/datacenters/{dc}/storage/tiers/{tier}TierResource#Updateatier
Manage datastore tiersapi/admin/datacenters/{datacenter}/datastoretiersDatastoreTierResource

Set global allocation rules

api/admin/rulesAllocationRulesResource

Set datacenter allocation rules

api/admin/rulesAllocationRulesResource
Manage backup policiesapi/admin/datacenters/{dc}/backuppoliciesBackupPolicyResource
Edit backup policy propertiesapi//admin/datacenters/{datacenter}/backuppropertiesBackupDatacenterPropertiesResource
Manage backup managerapi/admin/datacenters/{dc}/backupmanagerBackupManagerResource

Virtual Datacenters

  
Virtual infrastructureapi/cloud 

Create virtual datacenter

api/cloud/virtualdatacentersVirtualDatacenterResource#Createavirtualdatacenter
Synchronize public cloudapi/cloud/virtualdatacenters/

Retrieve: LocationsResource#Retrievealistofremotevirtualdatacentersfromapubliccloudregion
Synchronize: VirtualDatacenterResource#Synchronizeavirtualdatacenter

Create virtual appliance

api/cloud/virtualdatacenters/{vdc}/virtualappliancesVirtualApplianceResource#Createavirtualappliance
Create virtual appliance based on specapi/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliancesVirtualApplianceResource#Createavirtualappliancefromaspec
Create virtual appliance specapi/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliancesVirtualApplianceResource#Createavirtualappliancespec

Create private network

api/cloud/virtualdatacenters/{vdc}/privatenetworksPrivateNetworksResource#Createnewprivatenetwork

Create public network

api/cloud/virtualdatacenters/{vdc}/publicips/purchased/{ip}VirtualDatacenterResource#PurchaseapublicIPtobeusedinaVirtualMachineintheVirtualDatacenter
Create network IPapi/cloud/locations/{id}/ipsIPsResource

Create volume

api/cloud/virtualdatacenters/{vdc}/volumesVolumeResource#Createavolumeinavirtualdatacenter
Create a hard disk (star)api/cloud/virtualdatacenters/{vdc}/disksIn the API, hard disks are created at VDC level, not VM level
HardDiskResource#Createaharddisk

Edit Virtual Machine

api/cloud/virtualdatacenters/{vdc}/virtualappliances/{vapp}/virtualmachines/{vm}
api/cloud/virtualdatacenters/{vdc}/virtualappliances/{vapp}/virtualmachines/{vm}/storage/volumes/{vol}
api/cloud/virtualdatacenters/{vdc}/virtualappliances/{vapp}/virtualmachines/{vm}/storage/disks/{disk}
api/cloud/virtualdatacenters/{vdc}/virtualappliances/{vapp}/virtualmachines/{vm}/network

VirtualMachineResource#ModifyaVirtualMachine
Network and Volumes
VirtualMachineConfigurationResource 

Use Instances of Virtual Machines

api/admin/enterprises/{ent}/datacenterrepositories/{dcrepo}//actions/refresh
api/admin/enterprises/{ent}/datacenterrepositories/{dcrepo}/virtualmachinetemplates
api/admin/enterprises/{ent}/datacenterrepositories/{dcrepo}/virtualmachinetemplates/{vmt}/action/instances
api/cloud/virtualdatacenters/{vdc}/virtualappliances/{vapp}/virtualmachines

DatacenterRepositoryResource#Refreshadatacenterrepositorytodetectnewvirtualmachinetemplates
VirtualMachineTemplateResource#Retrieveallvirtualmachinetemplates
VirtualMachineTemplateResource#Retrievethevirtualmachinetemplatesinstancesusingthecurrenttemplate
VirtualMachineResource#Createavirtualmachine

 

Create VM Network Interface

/admin/datacenters/{dc}/network/{pubn}/ips

api/cloud/virtualdatacenters/{vdc}/privatenetworks
api/cloud/virtualdatacenters/{vdc}/privatenetworks/{prin}/ips

api/admin/enterprises/{ent}/limits/{limit}/externalnetworks
api/admin/enterprises/{ent}/limits/{limit}/externalnetworks/{extn}/ips

api/cloud/virtualdatacenters/{vdc}//publicips/topurchase/{ip}
api/cloud/virtualdatacenters/{vdc}/publicips/purchased/{ip}

Get IPs from datacenter networks (public, external - all except private)
PublicIpResource 
Get private networks and IP addresses
PrivateNetworksResource#Getlistofprivatenetworks
PrivateNetworksResource#ReturnalistofIPaddresses 
Get external networks and IP addresses
ExternalNetworksResource#Getthelistofexternalnetworks
ExternalNetworksResource#GetexternalnetworklistofIPs 
Get and purchase public IP addresses
VirtualMachineResource#ModifyaVirtualMachine

Create VM instance

api/cloud/virtualdatacenters/{vdc}/virtualappliances/{vapp}/virtualmachines/{vm}/action/instanceVirtualMachineResource#InstanceaVirtualMachine

Create persistent VM

api/admin/enterprises/{ent}/datacenterrepositories/{dcrepo}/virtualmachinetemplates
api/cloud/virtualdatacenters/{vdc}/volumes
api/admin/enterprises/{ent}/datacenterrepositories/{decrepo}/virtualmachinetemplates

Retrieve all templates
VirtualMachineTemplateResource#Retrieveallvirtualmachinetemplates
Retrieve all volumes in VDC
VolumeResource#Retrievevolumes
Send template (including existing volume), volume and virtual datacenter links to create new persistent template
VirtualMachineTemplateResource#Createanewpersistenttemplate

Capture VM in datacenter

api/admin/datacenters/{dc}/racks/{rk}/machines/{m}/virtualmachines
api/admin/datacenters/{dc}/racks/{rk}/machines/{m}/virtualmachines/{vm}
api/cloud/virtualdatacenters/{vdc}/virtualappliances/{vapp}/virtualmachines

Retrieve the VMs deployed on the physical machine
VirtualMachinesFromInfrastructureResource#ReturnsthelistofVirtualMachinesdeployedinaPhysicalMachine
Retrieve all information about the VM including resources
VirtualMachinesFromInfrastructureResource#Retrieveavirtualmachinewithresourcesdeployedonaphysicalmachine
Capture a retrieved machine
VirtualMachinesFromInfrastructureResource#Captureanon-managedvirtualmachine

More info while deploying VApp

  
Create VM layer

api/cloud/virtualdatacenters/{vdc}/virtualappliances/{vapp}/layers
api/cloud/virtualdatacenters/{vdc}/virtualappliances/{vapp}/layers/{layer}

Also see wiki reference

Define a layer with a VM and a layer name
LayersResource#Definenewlayer
Modify a layer to change its name or modify the virtual machines in the layer
LayersResource#Changelayernameandvirtualmachines

Upload and replace template disks via API

Manage scaling groupapi/cloud/virtualdatacenters/\{virtualdatacenter}/virtualappliances/\{virtualappliance}/scalingroups/\{scalinggroup}

ScalingGroupResource

VirtualMachineResource#Cloneavirtualmachine

Create/edit firewall

api/cloud/locations/{location}/device/{device}/firewalls

FirewallPoliciesResource

Edit firewall rules

api//cloud/locations/{location}/devices/{device}/firewalls/{firewall}/rules

FirewallRulesResource

Create/edit load balancer

api/cloud/locations/{location}/device/{device}/loadbalancers

LoadBalancerResource
LoadBalancerAddressesResource
LoadBalancerHealthStateResource
LoadBalancerVirtualMachinesResource
and so on! 

Manage virtual machine alarms

api/cloud/virtualdatecenters/x/virtualappliances/y/virtualmachines/z/metrics/r/alarms

MetricAlarmResource

Manage virtual appliance alerts

api/cloud/virtualdatecenters/x/virtualappliances/alerts

AlertResource

Manage action plans and triggers

api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualapplince}/virtualmachines/{virtualmachine}/actionplans

VirtualMachineActionPlanResource

Apps Library

  

Apps library section
(wizard)

api/admin/enterprises/{ent}/datacenterrepositories/{dcrepo}//actions/refresh

Refresh Apps Library
DatacenterRepositoryResource#Refreshadatacenterrepositorytodetectnewvirtualmachinetemplates

Upload VM template

See wiki referenceAppliance Manager Template API Upload and Download
Edit VM template

api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}
api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}/disks

And also

VirtualMachineTemplateResource#Modifyavitualmachinetemplate

Modify template disk: DisksResource#Modifyadiskofavirtualmachinetemplate

Download, promote, duplicate or export a VM templateapi/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplatesVirtualMachineTemplateResource#Requestcreationofanewvirtualmachinetemplateinthedatacenterrepository
Manage spec versionsapi/admin/enterprises/{enterprise}/vappspecs/{spec}VirtualApplianceResource#Createavirtualappliancespecversion

Users

  

Create enterprise

api/admin/enterprisesCreate an enterprise - but remember that users cannot deploy until a datacenter limit is created
EnterpriseResource#Createanenterprise

Create datacenter limits

api/admin/enterprises/{ent}/limitsEnable users to access datacenter and use datacenter resources, for example, deploy VMs
DatacenterLimitsResource#Createadatacenterlimit 

Create user

api/admin/enterprises/{ent}/usersUserResource#CreateaUserDtoentity.

Create role

api/admin/roles

Create a role
RolesResource#CreateRole

Create scopeapi/admin/scopesScopes Resource#Createascope

Pricing

  

Create currency

api/config/currenciesCurrencyResource#CreateanewCurrency

Create cost code

api/config/costcodes
api/config/costcodes/{costcode}/currencies
CostCodeResource#CreateNewCostCode
Set a cost code for each currency
CostCodeCurrencyResource

Create pricing template

api/config/pricingtemplatesPricingTemplateResource#CreateanewPricingTemplate

Configuration

  

Configuration tab

api/config/propertiesSystem properties set in GUI Configuration view
SystemPropertyResource

Licence tab

api/config/licensesLicenseResource