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

Contents:

Allowed locations Resource

This resource represents the cloud locations allowed to be used by the requesting user, based on the allowed datacenters and public cloud regions of the user's enterprise.

Main URI of the Resource

This class operates mainly over the Resource URI: /cloud/locations

Exposed Methods

List allowed datacenters

Returns a list of the cloud locations that the requesting user is allowed to access, based on the allowed datacenters and public cloud regions of the user's enterprise.

A cloud admin can list all the allowed locations using the query parameter allenterprises or can filter them by enterprise using the query parameter enterprise.

Synopsis: GET http://example.com/api/cloud/locations
Roles Required: VDC_ENUMERATE,APPLIB_VIEW,MANAGE_FIREWALLS,MANAGE_FLOATINGIPS,MANAGE_LOADBALANCERS 
Request Headers: Accept: application/vnd.abiquo.datacenters+json; version=4.4; application/vnd.abiquo.datacenters+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

idEnterprise

false

 

identifier of an enterprise

inscopefalsefalsefiter by locations in the user scope

Request Message Body Entity:
Response Message Body Entity: Datacenter Media Type
Request Example:

 Click here to show or hide the request example

GET_cld_locs_AC_dcs_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations \ 
	 -H 'Accept:application/vnd.abiquo.datacenters+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 1, 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations?limit=25&by=name&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations?startwith=0&limit=25&by=name&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "name": "623", 
      "location": "624", 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/enterprises/1276/datacenterrepositories/896", 
          "type": "application/vnd.abiquo.datacenterrepository+json", 
          "rel": "datacenterrepository", 
          "title": "repository"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "self", 
          "title": "623"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/ips", 
          "type": "application/vnd.abiquo.publicips+json", 
          "rel": "ips", 
          "title": "floating ips"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/availabilityzones", 
          "type": "application/vnd.abiquo.availabilityzones+json", 
          "rel": "availabilityzones", 
          "title": "availability zones"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/devices", 
          "type": "application/vnd.abiquo.devices+json", 
          "rel": "devices", 
          "title": "devices"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/templates", 
          "type": "application/vnd.abiquo.virtualmachinetemplates+json", 
          "rel": "templates", 
          "title": "available templates"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/action/remotevirtualdatacenters", 
          "type": "application/vnd.abiquo.virtualdatacenters+json", 
          "rel": "remotevirtualdatacenters", 
          "title": "remote vdcs"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/action/remotevirtualmachines", 
          "type": "application/vnd.abiquo.virtualmachines+json", 
          "rel": "remotevirtualmachines", 
          "title": "remote vms"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/backuppolicies", 
          "type": "application/vnd.abiquo.backuppolicies+json", 
          "rel": "backuppolicies", 
          "title": "backup policies"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/backupproperties", 
          "type": "application/vnd.abiquo.backupdatacenterproperties+json", 
          "rel": "backupproperties", 
          "title": "backup location properties"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/datastoretiers/action/compatibles", 
          "type": "application/vnd.abiquo.links+json", 
          "rel": "compatibles", 
          "title": "compatible datastore tiers"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/896/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }
      ], 
      "id": 896
    }
  ]
}

Example from previous versions

Get the list of allowed datacenters example
curl -X GET http://example.com/api/cloud/locations \
	 -H 'Accept: application/vnd.abiquo.datacenters+xml;version=3.0' \
	 -u user:password --verbose


GET http://example.com/api/admin/locations HTTP/1.1
Accept: application/vnd.abiquo.datacenters+xml;version=3.0


HTTP/1.1 200 OK
Content-Type: application/vnd.abiquo.datacenters+xml;version=3.0

<datacenters>
    <link rel="first" href="http://example.com/api/cloud/locations?limit=25&amp;by=name"/>
    <link rel="last" href="http://example.com/api/cloud/locations?startwith=0&amp;limit=25&amp;by=name"/>
    <totalSize>1</totalSize>
    <datacenter>
        <link title="repository" rel="datacenterrepository" type="application/vnd.abiquo.datacenterrepository+xml" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/2"/>
        <link title="datacenter" rel="self" type="application/vnd.abiquo.datacenter+xml" href="http://example.com/api/cloud/locations/2"/>
        <link title="floating ips" rel="ips" type="application/vnd.abiquo.publicips+xml" href="http://example.com/api/cloud/locations/2/ips"/>
        <link title="availability zones" rel="availabilityzones" type="application/vnd.abiquo.availabilityzones+xml" href="http://example.com/api/cloud/locations/2/availabilityzones"/>
        <link title="firewalls" rel="firewalls" type="application/vnd.abiquo.firewallpolicies+xml" href="http://example.com/api/cloud/locations/2/firewalls"/>
        <id>2</id>
        <name>datacenter</name>
        <location>Barcelona</location>
    </datacenter>
</datacenters>

List allowed public cloud regions

Synopsis: GET  http://example.com/api/cloud/locations  
Roles Required: ROLE_VDC_MANAGE 
Request Headers: Accept:  application/vnd.abiquo.publiccloudregions+json; version=4.4; application/vnd.abiquo.publiccloudregions+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

idEnterprise

false

 

identifier of an enterprise

inscopefalsefalsefiter by locations in the user scope
providerfalse provider name, e.g. AMAZON, from hypervisor types, see HypervisorTypeResource#Retrieveallhypervisortypes

Request Message Body Entity:
Response Message Body Entity: Public Cloud Region Media Type
Request Example:

Get cloud locations

 Click here to expand...

GET_cld_locs_AC_pubcldregs_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations \ 
	 -H 'Accept:application/vnd.abiquo.publiccloudregions+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 3, 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations?limit=25&by=name&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations?startwith=0&limit=25&by=name&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "id": 1424, 
      "links": [
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST", 
          "type": "application/vnd.abiquo.hypervisortype+json", 
          "rel": "hypervisortype", 
          "title": "CloudProviderTest"
        }, 
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST/regions/389", 
          "type": "application/vnd.abiquo.region+json", 
          "rel": "region", 
          "title": "389"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2207/datacenterrepositories/1424", 
          "type": "application/vnd.abiquo.datacenterrepository+json", 
          "rel": "datacenterrepository", 
          "title": "repository"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "self", 
          "title": "391"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/ips", 
          "type": "application/vnd.abiquo.publicips+json", 
          "rel": "ips", 
          "title": "floating ips"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/availabilityzones", 
          "type": "application/vnd.abiquo.availabilityzones+json", 
          "rel": "availabilityzones", 
          "title": "availability zones"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/devices", 
          "type": "application/vnd.abiquo.devices+json", 
          "rel": "devices", 
          "title": "devices"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/templates", 
          "type": "application/vnd.abiquo.virtualmachinetemplates+json", 
          "rel": "templates", 
          "title": "available templates"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/action/remotevirtualdatacenters", 
          "type": "application/vnd.abiquo.virtualdatacenters+json", 
          "rel": "remotevirtualdatacenters", 
          "title": "remote vdcs"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/action/remotevirtualmachines", 
          "type": "application/vnd.abiquo.virtualmachines+json", 
          "rel": "remotevirtualmachines", 
          "title": "remote vms"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/action/sync", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "sync", 
          "title": "sync public cloud region"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1424/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }
      ], 
      "name": "391"
    }, 
    {
      "id": 1425, 
      "links": [
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST", 
          "type": "application/vnd.abiquo.hypervisortype+json", 
          "rel": "hypervisortype", 
          "title": "CloudProviderTest"
        }, 
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST/regions/392", 
          "type": "application/vnd.abiquo.region+json", 
          "rel": "region", 
          "title": "392"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2207/datacenterrepositories/1425", 
          "type": "application/vnd.abiquo.datacenterrepository+json", 
          "rel": "datacenterrepository", 
          "title": "repository"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "self", 
          "title": "394"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/ips", 
          "type": "application/vnd.abiquo.publicips+json", 
          "rel": "ips", 
          "title": "floating ips"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/availabilityzones", 
          "type": "application/vnd.abiquo.availabilityzones+json", 
          "rel": "availabilityzones", 
          "title": "availability zones"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/devices", 
          "type": "application/vnd.abiquo.devices+json", 
          "rel": "devices", 
          "title": "devices"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/templates", 
          "type": "application/vnd.abiquo.virtualmachinetemplates+json", 
          "rel": "templates", 
          "title": "available templates"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/action/remotevirtualdatacenters", 
          "type": "application/vnd.abiquo.virtualdatacenters+json", 
          "rel": "remotevirtualdatacenters", 
          "title": "remote vdcs"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/action/remotevirtualmachines", 
          "type": "application/vnd.abiquo.virtualmachines+json", 
          "rel": "remotevirtualmachines", 
          "title": "remote vms"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/action/sync", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "sync", 
          "title": "sync public cloud region"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1425/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }
      ], 
      "name": "394"
    }, 
    {
      "id": 1426, 
      "links": [
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST", 
          "type": "application/vnd.abiquo.hypervisortype+json", 
          "rel": "hypervisortype", 
          "title": "CloudProviderTest"
        }, 
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST/regions/395", 
          "type": "application/vnd.abiquo.region+json", 
          "rel": "region", 
          "title": "395"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2207/datacenterrepositories/1426", 
          "type": "application/vnd.abiquo.datacenterrepository+json", 
          "rel": "datacenterrepository", 
          "title": "repository"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "self", 
          "title": "397"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/ips", 
          "type": "application/vnd.abiquo.publicips+json", 
          "rel": "ips", 
          "title": "floating ips"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/availabilityzones", 
          "type": "application/vnd.abiquo.availabilityzones+json", 
          "rel": "availabilityzones", 
          "title": "availability zones"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/devices", 
          "type": "application/vnd.abiquo.devices+json", 
          "rel": "devices", 
          "title": "devices"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/templates", 
          "type": "application/vnd.abiquo.virtualmachinetemplates+json", 
          "rel": "templates", 
          "title": "available templates"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/action/remotevirtualdatacenters", 
          "type": "application/vnd.abiquo.virtualdatacenters+json", 
          "rel": "remotevirtualdatacenters", 
          "title": "remote vdcs"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/action/remotevirtualmachines", 
          "type": "application/vnd.abiquo.virtualmachines+json", 
          "rel": "remotevirtualmachines", 
          "title": "remote vms"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/action/sync", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "sync", 
          "title": "sync public cloud region"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1426/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }
      ], 
      "name": "397"
    }
  ]
}

Get cloud locations by provider name

 Click here to expand...


GET_cld_locs_AC_pubcldregs_j_provider.0002.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations?provider=AMAZON \ 
	 -H 'Accept:application/vnd.abiquo.publiccloudregions+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 1, 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations?provider=AMAZON&limit=25&by=name&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations?provider=AMAZON&startwith=0&limit=25&by=name&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "id": 1423, 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/1423", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "edit", 
          "title": "388"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/1423/enterprises", 
          "type": "application/vnd.abiquo.enterprises+json", 
          "rel": "enterprises", 
          "title": "enterprises"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/1423/remoteservices", 
          "type": "application/vnd.abiquo.remoteservices+json", 
          "rel": "remoteservices", 
          "title": "remote services"
        }, 
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/AMAZON", 
          "type": "application/vnd.abiquo.hypervisortype+json", 
          "rel": "hypervisortype", 
          "title": "Amazon"
        }, 
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/AMAZON/regions/386", 
          "type": "application/vnd.abiquo.region+json", 
          "rel": "region", 
          "title": "386"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "location", 
          "title": "388"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/1423/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/1423/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2204/datacenterrepositories/1423", 
          "type": "application/vnd.abiquo.datacenterrepository+json", 
          "rel": "datacenterrepository", 
          "title": "repository"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "self", 
          "title": "388"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/ips", 
          "type": "application/vnd.abiquo.publicips+json", 
          "rel": "ips", 
          "title": "floating ips"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/availabilityzones", 
          "type": "application/vnd.abiquo.availabilityzones+json", 
          "rel": "availabilityzones", 
          "title": "availability zones"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/devices", 
          "type": "application/vnd.abiquo.devices+json", 
          "rel": "devices", 
          "title": "devices"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/templates", 
          "type": "application/vnd.abiquo.virtualmachinetemplates+json", 
          "rel": "templates", 
          "title": "available templates"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/action/remotevirtualdatacenters", 
          "type": "application/vnd.abiquo.virtualdatacenters+json", 
          "rel": "remotevirtualdatacenters", 
          "title": "remote vdcs"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/action/remotevirtualmachines", 
          "type": "application/vnd.abiquo.virtualmachines+json", 
          "rel": "remotevirtualmachines", 
          "title": "remote vms"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/action/sync", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "sync", 
          "title": "sync public cloud region"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/1423/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }
      ], 
      "name": "388"
    }
  ]
}

Examples from previous versions

 Click here to show or hide the request example
Get the list of allowed public cloud regions example
curl -X GET http://example.com/api/cloud/locations \
	 -H 'Accept: application/vnd.abiquo.publiccloudregions+xml;version=3.0' \
	 -u user:password --verbose


GET http://example.com/api/admin/locations HTTP/1.1
Accept: application/vnd.abiquo.publiccloudregions+xml;version=3.0


HTTP/1.1 200 OK
Content-Type: application/vnd.abiquo.publiccloudregions+xml;version=3.0

<publiccloudregions>
    <link rel="first" href="http://example.com/api/cloud/locations?limit=25&amp;by=name"/>
    <link rel="last" href="http://example.com/api/cloud/locations?startwith=0&amp;limit=25&amp;by=name"/>
    <totalSize>1</totalSize>
    <publiccloudregion>
        <link title="eu-west-1" rel="region" type="application/vnd.abiquo.region+xml" href="http://example.com/api/config/hypervisortypes/AMAZON/regions/eu-west-1"/>
        <link title="repository" rel="datacenterrepository" type="application/vnd.abiquo.datacenterrepository+xml" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/1"/>
        <link title="eu-west-1" rel="self" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/cloud/locations/1"/>
        <link title="floating ips" rel="ips" type="application/vnd.abiquo.publicips+xml" href="http://example.com/api/cloud/locations/1/ips"/>
        <link title="availability zones" rel="availabilityzones" type="application/vnd.abiquo.availabilityzones+xml" href="http://example.com/api/cloud/locations/1/availabilityzones"/>
        <link title="firewalls" rel="firewalls" type="application/vnd.abiquo.firewallpolicies+xml" href="http://example.com/api/cloud/locations/1/firewalls"/>
        <link title="Amazon" rel="hypervisortype" type="application/vnd.abiquo.hypervisortype+xml" href="http://example.com/api/config/hypervisortypes/AMAZON"/>
        <id>1</id>
        <name>eu-west-1</name>
    </publiccloudregion>
</publiccloudregions>

Allowed location resource

This resource represents a cloud location allowed to the user given the ID of the location.

Main URI of the Resource

This class operates mainly over the Resource URI: /cloud/locations/{location}


Retrieve an allowed datacenter

Synopsis: GET http://example.com/api/cloud/locations/{datacenter}
Roles Required: VDC_ENUMERATE,APPLIB_VIEW,MANAGE_FIREWALLS,MANAGE_FLOATINGIPS,MANAGE_LOADBALANCERS 
Request Headers: Accept:  application/vnd.abiquo.datacenter+json; version=4.4; application/vnd.abiquo.datacenter+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: Datacenter Media Type
Request Example:

 Click here to show or hide the request example

GET_cld_locs_X_AC_dc_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1388 \ 
	 -H 'Accept:application/vnd.abiquo.datacenter+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "name": "2", 
  "location": "3", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "edit", 
      "title": "2"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/racks", 
      "type": "application/vnd.abiquo.racks+json", 
      "rel": "racks", 
      "title": "racks"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/remoteservices", 
      "type": "application/vnd.abiquo.remoteservices+json", 
      "rel": "remoteservices", 
      "title": "remote services"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/action/updateusedresources", 
      "type": "", 
      "rel": "updateusedresources", 
      "title": "update resources"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/datastores", 
      "type": "application/vnd.abiquo.datastores+json", 
      "rel": "datastores", 
      "title": "datastores"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/hypervisors", 
      "type": "application/vnd.abiquo.hypervisortypes+json", 
      "rel": "hypervisors", 
      "title": "hypervisors"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/action/enterprises", 
      "type": "application/vnd.abiquo.enterprises+json", 
      "rel": "enterprises", 
      "title": "enterprises"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/action/discover", 
      "type": "application/vnd.abiquo.machines+json", 
      "rel": "discover", 
      "title": "discover"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/action/checkmachinestate", 
      "type": "application/vnd.abiquo.machinestate+json", 
      "rel": "checkmachinestate", 
      "title": "machines state"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/action/checkmachineipmistate", 
      "type": "application/vnd.abiquo.machineipmistate+json", 
      "rel": "checkmachineipmistate", 
      "title": "machines ipmi"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/storage/tiers", 
      "type": "application/vnd.abiquo.tiers+json", 
      "rel": "tiers", 
      "title": "tiers"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/storage/devices", 
      "type": "application/vnd.abiquo.storagedevices+json", 
      "rel": "devices", 
      "title": "storage devices"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/devices", 
      "type": "application/vnd.abiquo.devices+json", 
      "rel": "devices", 
      "title": "devices"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/networkservicetypes", 
      "type": "application/vnd.abiquo.networkservicetypes+json", 
      "rel": "networkservicetypes", 
      "title": "network service types"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/network", 
      "type": "application/vnd.abiquo.vlans+json", 
      "rel": "network", 
      "title": "public networks"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/network/action/externalips", 
      "type": "application/vnd.abiquo.externalips+json", 
      "rel": "externalips", 
      "title": "external ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/action/getlimits", 
      "type": "application/vnd.abiquo.limits+json", 
      "rel": "getLimits", 
      "title": "limits"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/excludednetworks", 
      "type": "application/vnd.abiquo.excludednetworks+json", 
      "rel": "excludednetworks", 
      "title": "excluded networks"
    }, 
    {
      "href": "http://localhost:9009/api/admin/remoteservices/2155", 
      "type": "application/vnd.abiquo.remoteservice+json", 
      "rel": "remoteservice", 
      "title": "VIRTUALFACTORY"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "location", 
      "title": "2"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/metrics", 
      "type": "application/vnd.abiquo.metricsmetadata+json", 
      "rel": "metricsmetadata", 
      "title": "metricsmetadata"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/1388/metrics/collectd", 
      "type": "application/json", 
      "rel": "collectd", 
      "title": "collectd"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/2187/datacenterrepositories/1388", 
      "type": "application/vnd.abiquo.datacenterrepository+json", 
      "rel": "datacenterrepository", 
      "title": "repository"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "self", 
      "title": "2"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/ips", 
      "type": "application/vnd.abiquo.publicips+json", 
      "rel": "ips", 
      "title": "floating ips"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/availabilityzones", 
      "type": "application/vnd.abiquo.availabilityzones+json", 
      "rel": "availabilityzones", 
      "title": "availability zones"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/devices", 
      "type": "application/vnd.abiquo.devices+json", 
      "rel": "devices", 
      "title": "devices"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/templates", 
      "type": "application/vnd.abiquo.virtualmachinetemplates+json", 
      "rel": "templates", 
      "title": "available templates"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/action/remotevirtualdatacenters", 
      "type": "application/vnd.abiquo.virtualdatacenters+json", 
      "rel": "remotevirtualdatacenters", 
      "title": "remote vdcs"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/action/remotevirtualmachines", 
      "type": "application/vnd.abiquo.virtualmachines+json", 
      "rel": "remotevirtualmachines", 
      "title": "remote vms"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/backuppolicies", 
      "type": "application/vnd.abiquo.backuppolicies+json", 
      "rel": "backuppolicies", 
      "title": "backup policies"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/backupproperties", 
      "type": "application/vnd.abiquo.backupdatacenterproperties+json", 
      "rel": "backupproperties", 
      "title": "backup location properties"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/datastoretiers/action/compatibles", 
      "type": "application/vnd.abiquo.links+json", 
      "rel": "compatibles", 
      "title": "compatible datastore tiers"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/metrics", 
      "type": "application/vnd.abiquo.metricsmetadata+json", 
      "rel": "metricsmetadata", 
      "title": "metricsmetadata"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1388/metrics/collectd", 
      "type": "application/json", 
      "rel": "collectd", 
      "title": "collectd"
    }, 
    {
      "href": "http://localhost:9009/api/config/hypervisortypes/TEST_HYPERVISOR", 
      "type": "application/vnd.abiquo.hypervisortype+json", 
      "rel": "hypervisortype", 
      "title": "TestHypervisor"
    }
  ], 
  "id": 1388
}

Example from previous versions

Get an allowed datacenter example
curl -X GET http://example.com/api/cloud/locations/2 \
	 -H 'Accept: application/vnd.abiquo.datacenter+xml;version=3.0' \
	 -u user:password --verbose


GET http://example.com/api/admin/locations/2 HTTP/1.1
Accept: application/vnd.abiquo.datacenter+xml;version=3.0


HTTP/1.1 200 OK
Content-Type: application/vnd.abiquo.datacenter+xml;version=3.0

<datacenter>
	<link title="repository" rel="datacenterrepository" type="application/vnd.abiquo.datacenterrepository+xml" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/2"/>
    <link title="datacenter" rel="self" type="application/vnd.abiquo.datacenter+xml" href="http://example.com/api/cloud/locations/2"/>
    <link title="floating ips" rel="ips" type="application/vnd.abiquo.publicips+xml" href="http://example.com/api/cloud/locations/2/ips"/>
    <link title="availability zones" rel="availabilityzones" type="application/vnd.abiquo.availabilityzones+xml" href="http://example.com/api/cloud/locations/2/availabilityzones"/>
    <link title="firewalls" rel="firewalls" type="application/vnd.abiquo.firewallpolicies+xml" href="http://example.com/api/cloud/locations/2/firewalls"/>
    <id>2</id>
    <name>datacenter</name>
    <location>Barcelona</location>
</datacenter>

Retrieve an allowed public cloud region

Synopsis: GET http://example.com/api/cloud/locations/{publiccloudregion}
Roles Required: VDC_ENUMERATE,APPLIB_VIEW,MANAGE_FIREWALLS,MANAGE_FLOATINGIPS,MANAGE_LOADBALANCERS 
Request Headers: Accept:  application/vnd.abiquo.publiccloudregion+json; version=4.4; application/vnd.abiquo.publiccloudregion+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: Public Cloud Region Media Type
Request Example:

 Click here to show or hide the request example

GET_cld_locs_X_AC_pubcldreg_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/814 \ 
	 -H 'Accept:application/vnd.abiquo.publiccloudregion+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "id": 814, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/814", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "edit", 
      "title": "name"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/814/enterprises", 
      "type": "application/vnd.abiquo.enterprises+json", 
      "rel": "enterprises", 
      "title": "enterprises"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/814/remoteservices", 
      "type": "application/vnd.abiquo.remoteservices+json", 
      "rel": "remoteservices", 
      "title": "remote services"
    }, 
    {
      "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST", 
      "type": "application/vnd.abiquo.hypervisortype+json", 
      "rel": "hypervisortype", 
      "title": "CloudProviderTest"
    }, 
    {
      "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST/regions/region", 
      "type": "application/vnd.abiquo.region+json", 
      "rel": "region", 
      "title": "region"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "location", 
      "title": "name"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/814/metrics", 
      "type": "application/vnd.abiquo.metricsmetadata+json", 
      "rel": "metricsmetadata", 
      "title": "metricsmetadata"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/814/metrics/collectd", 
      "type": "application/json", 
      "rel": "collectd", 
      "title": "collectd"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/1075/datacenterrepositories/814", 
      "type": "application/vnd.abiquo.datacenterrepository+json", 
      "rel": "datacenterrepository", 
      "title": "repository"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "self", 
      "title": "name"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/ips", 
      "type": "application/vnd.abiquo.publicips+json", 
      "rel": "ips", 
      "title": "floating ips"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/availabilityzones", 
      "type": "application/vnd.abiquo.availabilityzones+json", 
      "rel": "availabilityzones", 
      "title": "availability zones"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/devices", 
      "type": "application/vnd.abiquo.devices+json", 
      "rel": "devices", 
      "title": "devices"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/templates", 
      "type": "application/vnd.abiquo.virtualmachinetemplates+json", 
      "rel": "templates", 
      "title": "available templates"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/action/remotevirtualdatacenters", 
      "type": "application/vnd.abiquo.virtualdatacenters+json", 
      "rel": "remotevirtualdatacenters", 
      "title": "remote vdcs"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/action/remotevirtualmachines", 
      "type": "application/vnd.abiquo.virtualmachines+json", 
      "rel": "remotevirtualmachines", 
      "title": "remote vms"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/hardwareprofiles", 
      "type": "application/vnd.abiquo.hardwareprofiles+json", 
      "rel": "hardwareprofiles", 
      "title": "hardwareprofiles"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/tasks", 
      "type": "application/vnd.abiquo.tasks+json", 
      "rel": "tasks", 
      "title": "tasks"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/action/sync", 
      "type": "application/vnd.abiquo.acceptedrequest+json", 
      "rel": "sync", 
      "title": "sync public cloud region"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/tasks", 
      "type": "application/vnd.abiquo.tasks+json", 
      "rel": "tasks", 
      "title": "tasks"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/metrics", 
      "type": "application/vnd.abiquo.metricsmetadata+json", 
      "rel": "metricsmetadata", 
      "title": "metricsmetadata"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/814/metrics/collectd", 
      "type": "application/json", 
      "rel": "collectd", 
      "title": "collectd"
    }
  ], 
  "name": "name"
}

Example from previous versions

Get an allowed public cloud region example
curl -X GET http://example.com/api/cloud/locations/1 \
	 -H 'Accept: application/vnd.abiquo.publiccloudregions+xml;version=3.0' \
	 -u user:password --verbose


GET http://example.com/api/admin/locations/1 HTTP/1.1
Accept: application/vnd.abiquo.publiccloudregion+xml;version=3.0


HTTP/1.1 200 OK
Content-Type: application/vnd.abiquo.publiccloudregion+xml;version=3.0

<publiccloudregion>
	<link title="eu-west-1" rel="region" type="application/vnd.abiquo.region+xml" href="http://example.com/api/config/hypervisortypes/AMAZON/regions/eu-west-1"/>
    <link title="repository" rel="datacenterrepository" type="application/vnd.abiquo.datacenterrepository+xml" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/1"/>
    <link title="eu-west-1" rel="self" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/cloud/locations/1"/>
    <link title="floating ips" rel="ips" type="application/vnd.abiquo.publicips+xml" href="http://example.com/api/cloud/locations/1/ips"/>
    <link title="availability zones" rel="availabilityzones" type="application/vnd.abiquo.availabilityzones+xml" href="http://example.com/api/cloud/locations/1/availabilityzones"/>
    <link title="firewalls" rel="firewalls" type="application/vnd.abiquo.firewallpolicies+xml" href="http://example.com/api/cloud/locations/1/firewalls"/>
    <link title="Amazon" rel="hypervisortype" type="application/vnd.abiquo.hypervisortype+xml" href="http://example.com/api/config/hypervisortypes/AMAZON"/>
    <id>1</id>
    <name>eu-west-1</name>
</publiccloudregion>

 

Retrieve a list of remote virtual datacenters from a public cloud region

Retrieve a list of all remote virtual datacenters from a public cloud region that the user is allowed to access. If the virtual datacenter is managed by Abiquo, the response object will contain a the Abiquo edit link for the virtual datacenter. From this list of virtual datacenters you can select the virtual datacenters to synchronize.

In AWS, the name and providerID attributes are separate. The name attribute contains the VPC name (if any) and the providerID attribute contains the VPC ID (e.g. vpc-12345678).

Synopsis: GET http://example.com/api/cloud/locations/{publiccloudregion}/action/remotevirtualdatacenters
Roles Required: VDC_ENUMERATE
Request Headers: Accept:  application/vnd.abiquo.virtualdatacenters+json; version=4.4; application/vnd.abiquo.virtualdatacenters+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: VirtualDatacenters Media Type
Request Example:

 Click here to show or hide the request example

GET_cld_locs_X_act_rmtvdcs_AC_vdcs_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1435/action/remotevirtualdatacenters \ 
	 -H 'Accept:application/vnd.abiquo.virtualdatacenters+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [], 
  "collection": [
    {
      "ramHard": 0, 
      "name": "", 
      "links": [], 
      "cpuHard": 0, 
      "vlansHard": 0, 
      "publicIpsHard": 0, 
      "publicIpsSoft": 0, 
      "providerId": "05a673e5-ed62-4144-91b9-bb3a0d12347b", 
      "vlansSoft": 0, 
      "ramSoft": 0, 
      "cpuSoft": 0
    }, 
    {
      "ramHard": 0, 
      "name": "", 
      "links": [], 
      "cpuHard": 0, 
      "vlansHard": 0, 
      "publicIpsHard": 0, 
      "publicIpsSoft": 0, 
      "providerId": "075e2a0e-c3a3-41f4-8093-4132f52b42b6", 
      "vlansSoft": 0, 
      "ramSoft": 0, 
      "cpuSoft": 0
    }, 
    {
      "ramHard": 0, 
      "name": "", 
      "links": [], 
      "cpuHard": 0, 
      "vlansHard": 0, 
      "publicIpsHard": 0, 
      "publicIpsSoft": 0, 
      "providerId": "277855c8-a5de-4a9b-aed3-7838668074f3", 
      "vlansSoft": 0, 
      "ramSoft": 0, 
      "cpuSoft": 0
    }
  ]
}

 

Retrieve a list of remote virtual machines from a public cloud region by remote VPC IDs

Retrieve a list of all virtual machines in a public cloud region and filter by VPC identifiers in a comma separated list. If the remote VPC identifier is set to "empty", this request retrieves the virtual machines from EC2 Classic, which have no VPC identifier. The virtual machine details retrieved are for information purposes only because you can only view EC2 Classic machines in Abiquo, you cannot synchronize them. The response objects do not contain information about whether the virtual machines are managed by Abiquo or not. 

Synopsis: GET http://example.com/api/cloud/locations/{publiccloudregion}/action/remotevirtualmachines
Roles Required: VDC_ENUMERATE 
Request Headers: Accept:  application/vnd.abiquo.virtualmachines+json; version=4.4; application/vnd.abiquo.virtualmachines+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

vpcids

false

 

Identifier of the VPC in AWS. If set to "empty", retrieve details of EC2 Classic machines

Request Message Body Entity:
Response Message Body Entity: VirtualMachines Media Type
Request Example:

Get a list of VMs in the public cloud region

 Click here to show or hide the request example
GET_cld_locs_X_act_rmtvms_AC_vms_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1438/action/remotevirtualmachines \ 
	 -H 'Accept:application/vnd.abiquo.virtualmachines+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [], 
  "collection": [
    {
      "links": [], 
      "idType": 0, 
      "variables": {}, 
      "ram": 0, 
      "highDisponibility": 0, 
      "creationTimestamp": 1512487480582, 
      "vdrpPort": 0, 
      "backuppolicies": [], 
      "monitored": false, 
      "name": "vm1", 
      "idState": 4, 
      "label": "vm1", 
      "vdrpEnabled": false, 
      "state": "ON", 
      "protected": false, 
      "lastSynchronize": 1512487480583, 
      "type": "NOT_MANAGED", 
      "cpu": 0, 
      "generateGuestInitialPassword": false, 
      "metadata": null
    }, 
    {
      "links": [], 
      "idType": 0, 
      "variables": {}, 
      "ram": 0, 
      "highDisponibility": 0, 
      "creationTimestamp": 1512487480583, 
      "vdrpPort": 0, 
      "backuppolicies": [], 
      "monitored": false, 
      "name": "vm2", 
      "idState": 4, 
      "label": "vm2", 
      "vdrpEnabled": false, 
      "state": "ON", 
      "protected": false, 
      "lastSynchronize": 1512487480583, 
      "type": "NOT_MANAGED", 
      "cpu": 0, 
      "generateGuestInitialPassword": false, 
      "metadata": null
    }, 
    {
      "links": [], 
      "idType": 0, 
      "variables": {}, 
      "ram": 0, 
      "highDisponibility": 0, 
      "creationTimestamp": 1512487480583, 
      "vdrpPort": 0, 
      "backuppolicies": [], 
      "monitored": false, 
      "name": "vm3", 
      "idState": 4, 
      "label": "vm3", 
      "vdrpEnabled": false, 
      "state": "ON", 
      "protected": false, 
      "lastSynchronize": 1512487480583, 
      "type": "NOT_MANAGED", 
      "cpu": 0, 
      "generateGuestInitialPassword": false, 
      "metadata": null
    }
  ]
}

Get a list of VMs in the public cloud region by VPC ID

 Click here to show or hide the request example

GET_cld_locs_X_act_rmtvms_AC_vms_j_vpcids.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1438/action/remotevirtualmachines?vpcids=empty,vpc3,,null,nomatch \ 
	 -H 'Accept:application/vnd.abiquo.virtualmachines+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [], 
  "collection": [
    {
      "links": [], 
      "idType": 0, 
      "variables": {}, 
      "ram": 0, 
      "highDisponibility": 0, 
      "creationTimestamp": 1512487480677, 
      "vdrpPort": 0, 
      "backuppolicies": [], 
      "monitored": false, 
      "name": "vm1", 
      "idState": 4, 
      "label": "vm1", 
      "vdrpEnabled": false, 
      "state": "ON", 
      "protected": false, 
      "lastSynchronize": 1512487480677, 
      "type": "NOT_MANAGED", 
      "cpu": 0, 
      "generateGuestInitialPassword": false, 
      "metadata": null
    }, 
    {
      "links": [], 
      "idType": 0, 
      "variables": {}, 
      "ram": 0, 
      "highDisponibility": 0, 
      "creationTimestamp": 1512487480677, 
      "vdrpPort": 0, 
      "backuppolicies": [], 
      "monitored": false, 
      "name": "vm3", 
      "idState": 4, 
      "label": "vm3", 
      "vdrpEnabled": false, 
      "state": "ON", 
      "protected": false, 
      "lastSynchronize": 1512487480677, 
      "type": "NOT_MANAGED", 
      "cpu": 0, 
      "generateGuestInitialPassword": false, 
      "metadata": null
    }
  ]
}

Retrieve allowed datastore tiers that are enabled in a datacenter location

Retrieve a list of all datastore tiers that are allowed in a given datacenter location and that are currently enabled for use. This method can be used to retrieve allowed, enabled datastore tiers when you wish to modify a disk and add it to a datastore tier. For example, in an undeployed virtual machine, or as a default datastore for a disk in virtual machine template. And for example, to set the default datastore tier for a virtual datacenter.

Synopsis: GET http://example.com/api/cloud/locations/{datacenter}/datastoretiers
Roles Required: VDC_MANAGE_VAPP
Request Headers: Accept:  application/vnd.abiquo.datastoretiers+json; version=4.4; application/vnd.abiquo.datastoretiers+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

    

Request Message Body Entity:
Response Message Body Entity: DatastoreTiers Media Type
Request Example:

Get a list of datastore tiers in the datacenter that the enterprise is allowed to use and that are enabled for use.

 Click here to show or hide the request example

GET_cld_locs_X_dstrs_AC_dstrs_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1386/datastoretiers \ 
	 -H 'Accept:application/vnd.abiquo.datastoretiers+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [], 
  "collection": [
    {
      "storageAllocationPolicy": "PROGRESSIVE", 
      "name": "Tier number 1", 
      "links": [
        {
          "href": "http://localhost:9009/api/cloud/locations/1386/datastoretiers/311", 
          "type": "application/vnd.abiquo.datastoretier+json", 
          "rel": "self", 
          "title": "Tier number 1"
        }
      ], 
      "defaultForDatacenter": true, 
      "defaultAllowed": true, 
      "enabled": true, 
      "description": "206"
    }
  ]
}

Retrieve datastore tiers that are compatible with the supplied tiers in a datacenter location

A virtual machine can only use datastore tiers that contain disks from the same hypervisor. Use this request to retrieve datastore tiers that are compatible with a list of one or more tiers, using links to datastore tiers. If you supply more than one tier, the intersection of the compatible tiers is returned. 

Synopsis: PUT http://example.com/api/cloud/locations/1/datastoretiers/action/compatibles
Roles Required:  VDC_MANAGE_VAPP
Request Headers:  Accept:  application/vnd.abiquo.links+json; version=4.4; application/vnd.abiquo.links+xml; version=4.4;  Content-type:  application/vnd.abiquo.links+json; version=4.4; application/vnd.abiquo.links+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: Abiquo Data Media Types#Links Media Type 
Response Message Body Entity: Abiquo Data Media Types#Links Media Type
Request Example:

 Click here to show or hide the request example


PUT_cld_locs_X_dstrs_act_CT_links_j_AC_links_j.txt

cURL:

curl -X PUT https://example.com/api/cloud/locations/1/datastoretiers/action/compatibles' \  
	-H 'Accept: application/vnd.abiquo.links+json;version=4.2' \ 
	-H 'Content-Type: application/vnd.abiquo.links+json;version=4.2' \
	-d @requestpayload.json \ 
	-u user:password --verbose 

Success status code: 200

Request payload:

{
    "links": [
    	{
        	"title": "Default Tier",
            "rel": "self",
            "type": "application/vnd.abiquo.datastoretier+json",
            "href": "https://example.com:443/api/cloud/locations/1/datastoretiers/1"
        }
	]
}

 

Response payload:

{
    "links": [
        {
            "title": "Default Tier",
            "rel": "self",
            "type": "application/vnd.abiquo.datastoretier+json",
            "href": "https://example.com:443/api/cloud/locations/1/datastoretiers/1"
        },
        {
            "title": "SecondTier",
            "rel": "self",
            "type": "application/vnd.abiquo.datastoretier+json",
            "href": "https://example.com:443/api/cloud/locations/1/datastoretiers/2"
        }
    ]
}

Retrieve an allowed datastore tier that is enabled in a datacenter location

Retrieve a datastore tier that is allowed in a given datacenter location and that is currently enabled for use. This method can be used to retrieve an allowed, enabled tier.

Synopsis: GET http://example.com/api/cloud/locations/{datacenter}/datastoretiers/{datastoretier}
Roles Required: VDC_MANAGE_VAPP
Request Headers: Accept:  application/vnd.abiquo.datastoretier+json; version=4.4; application/vnd.abiquo.datastoretier+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

    

Request Message Body Entity:
Response Message Body Entity: DatastoreTier Media Type
Request Example:

Get a list of datastore tiers in the datacenter that the enterprise is allowed to use and that are enabled for use.

 Click here to show or hide the request example

GET_cld_locs_X_dstrs_X_AC_dstr_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/278/datastoretiers/153 \ 
	 -H 'Accept:application/vnd.abiquo.datastoretier+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "storageAllocationPolicy": "PROGRESSIVE", 
  "name": "875", 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations/278/datastoretiers/153", 
      "type": "application/vnd.abiquo.datastoretier+json", 
      "rel": "self", 
      "title": "875"
    }
  ], 
  "defaultForDatacenter": false, 
  "defaultAllowed": true, 
  "enabled": true, 
  "description": "876"
}

List availability zones for a location

See AvailabilityZoneResource

Get an availability zone in a location

See AvailabilityZoneResource


List hardware profiles for a location

Retrieve hardware profiles that are allowed in a given location that the enterprise allowed to use and are enabled for use.

Synopsis: GET   http://example.com/api/cloud/locations/{location}/hardwareprofiles
Roles Required: VDC_ENUMERATE,APPLIB_ALLOW_MODIFY
Request Headers: Accept:  application/vnd.abiquo.hardwareprofiles+json; version=4.4; application/vnd.abiquo.hardwareprofiles+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

    

Request Message Body Entity:
Response Message Body Entity: HardwareProfiles Media Type
Request Example:

Get a list of hardware profiles that the enterprise is allowed to use and that are enabled for use.

 Click here to show or hide the request example

GET_cld_locs_X_hwprofs_AC_hwprofs_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/7/hardwareprofiles \ 
	 -H 'Accept:application/vnd.abiquo.hardwareprofiles+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [], 
  "collection": [
    {
      "providerId": "317", 
      "name": "317", 
      "links": [
        {
          "href": "http://localhost:9009/api/cloud/locations/7/hardwareprofiles/1", 
          "type": "application/vnd.abiquo.hardwareprofile+json", 
          "rel": "self", 
          "title": "317"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/9", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "bar"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/7", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "location", 
          "title": "314"
        }
      ], 
      "active": true, 
      "ramInMb": 319, 
      "cpu": 318
    }, 
    {
      "providerId": "341", 
      "name": "341", 
      "links": [
        {
          "href": "http://localhost:9009/api/cloud/locations/7/hardwareprofiles/2", 
          "type": "application/vnd.abiquo.hardwareprofile+json", 
          "rel": "self", 
          "title": "341"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/9", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "bar"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/7", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "location", 
          "title": "314"
        }
      ], 
      "active": true, 
      "ramInMb": 343, 
      "cpu": 342
    }
  ]
}

Get a hardware profile for a location

Retrieve a hardware profile that is allowed in a given location that the enterprise allowed to use and is enabled for use.

Synopsis: GET   http://example.com/api/cloud/locations/{location}/hardwareprofiles/{hardwareprofile}
Roles Required: VDC_ENUMERATE,APPLIB_ALLOW_MODIFY
Request Headers: Accept:  application/vnd.abiquo.hardwareprofile+json; version=4.4; application/vnd.abiquo.hardwareprofile+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

    

Request Message Body Entity:
Response Message Body Entity: HardwareProfile Media Type
Request Example:

Get a hardware profile that the enterprise is allowed to use and that is enabled for use.

 Click here to show or hide the request example

GET_cld_locs_X_hwprofs_X_AC_hwprof_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/68/hardwareprofiles/47 \ 
	 -H 'Accept:application/vnd.abiquo.hardwareprofile+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "providerId": "ABQ_HP_1_4_542adce8", 
  "name": "ABQ_HP_1_4_542adce8", 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations/68/hardwareprofiles/47", 
      "type": "application/vnd.abiquo.hardwareprofile+json", 
      "rel": "self", 
      "title": "ABQ_HP_1_4_542adce8"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/116", 
      "type": "application/vnd.abiquo.enterprise+json", 
      "rel": "enterprise", 
      "title": "4762"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/68", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "location", 
      "title": "4767"
    }
  ], 
  "active": true, 
  "ramInMb": 4, 
  "cpu": 1
}

List templates for a location

Retrieve templates that are present in a given location.

Paging Method

This method works with paging. Check out Basic Behaviors for information about how it works

Synopsis: GET   http://example.com/api/cloud/locations/{location}/templates
Roles Required: VDC_ENUMERATE
Request Headers: Accept:  application/vnd.abiquo.templates+json; version=4.4; application/vnd.abiquo.templates+xml; version=4.4;
Request Parameters:


Parameter

Required

Default Value

Description

categoryName

false

 

name of a category

hypervisorTypeName

false

 

type of an hypervisor

virtualdatacenter

false

 

identifier of a virtual datacenter

stateful

false

 

string value to inclued persistent templates, it can be ALL, USED or NOTUSED

imported

false

false

boolean to include imported templates

ostype

false

 

comma separated value, optionally filter by operating systems (null for no filter)

is64bits

false

 

optionally filter by x64 architecture. It requires ''ostype'' param set to null
(null for any filter)

startwith

false

0

first element to retrieve

descriptionfalse
description of the template
namefalse

pathfalse

ovfIdfalse

creationUserfalse
the user that created the template, can be an inexistent user or a simple identifier

by

false

id

ordering the request.

has

false

 

filter the request. With this parameter the response just contains the elements
which name matches the filter value.

limit

false

25

number of elements to return

asc

false

true

order ascending or descending. By default the sort mode is ascending.

masterInclusionfalse if specified only returns templates with or without master link relation
includeOrphanInstancesfalsefalse

Only apply when masterInclusion is true. Also includes instances with the master not visible (not shared and in another enterprise)

statesParamfalse if present only returns templates in the desired states (comma separated values)
includeExternalfalsetrue 

Request Message Body Entity:
Response Message Body Entity: VirtualMachineTemplates Media Type
Request Example:

Get a list of templates that are available to the enterprise in the location.

 Click here to show or hide the request example

GET_cld_locs_X_tmps_AC_vmtmps_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1460/templates \ 
	 -H 'Accept:application/vnd.abiquo.virtualmachinetemplates+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 1, 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations/1460/templates?limit=25&by=id&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1460/templates?startwith=0&limit=25&by=id&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "links": [
        {
          "href": "http://localhost:9009/api/admin/enterprises/2250", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "596"
        }, 
        {
          "href": "http://localhost:9009/api/config/categories/810", 
          "type": "application/vnd.abiquo.category+json", 
          "rel": "category", 
          "title": "611"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2250/datacenterrepositories/1460/virtualmachinetemplates/843", 
          "type": "application/vnd.abiquo.virtualmachinetemplate+json", 
          "rel": "edit", 
          "title": "612"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2250/datacenterrepositories/1460/virtualmachinetemplates/843/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2250/datacenterrepositories/1460", 
          "type": "application/vnd.abiquo.datacenterrepository+json", 
          "rel": "datacenterrepository", 
          "title": "repository"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2250/datacenterrepositories/1460/virtualmachinetemplates/843/action/virtualmachines", 
          "type": "application/vnd.abiquo.virtualmachines+json", 
          "rel": "virtualmachines", 
          "title": "virtual machines"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2250/datacenterrepositories/1460/virtualmachinetemplates/843/disks", 
          "type": "application/vnd.abiquo.disks+json", 
          "rel": "disks", 
          "title": "disks"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2250/datacenterrepositories/1460/virtualmachinetemplates/843/disks/790", 
          "type": "application/vnd.abiquo.disk+json", 
          "rel": "disk0"
        }, 
        {
          "href": "http://613", 
          "rel": "templatedefinition", 
          "title": "template definition"
        }, 
        {
          "href": "http://localhost:8080/am/erepos/2250/templates/", 
          "rel": "templatePath", 
          "title": "template path"
        }
      ], 
      "variables": {}, 
      "enableCpuHotAdd": false, 
      "creationUser": "973741777", 
      "ramRequired": 4, 
      "iconUrl": "http://validiconurl.com/icon.jpg", 
      "enableRemoteAccessHotReconfigure": false, 
      "enableDisksHotReconfigure": false, 
      "osType": "DEBIAN_64", 
      "creationDate": "2017-12-05T15:24:43.000+0000", 
      "id": "843", 
      "enableOnlyHPRecommended": false, 
      "chefEnabled": false, 
      "name": "612", 
      "state": "DONE", 
      "enableNicsHotReconfigure": false, 
      "enableRamHotAdd": false, 
      "shared": false, 
      "cpuRequired": 1, 
      "generateGuestInitialPassword": false
    }
  ]
}

Get a template in a location

Get a template that is available to the enterprise in a location.

Synopsis: GET   http://example.com/api/cloud/locations/{location}/templates/{template}
Roles Required: VDC_ENUMERATE
Request Headers: Accept:  application/vnd.abiquo.virtualmachinetemplate+json; version=4.4; application/vnd.abiquo.virtualmachinetemplate+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

    

Request Message Body Entity:
Response Message Body Entity: VirtualMachineTemplate Media Type
Request Example:

Get a template that the enterprise is allowed to use and that is enabled for use.

 Click here to show or hide the request example

GET_cld_locs_X_tmps_X_AC_vmtmp_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1442/templates/805 \ 
	 -H 'Accept:application/vnd.abiquo.virtualmachinetemplate+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/admin/enterprises/2218", 
      "type": "application/vnd.abiquo.enterprise+json", 
      "rel": "enterprise", 
      "title": "4"
    }, 
    {
      "href": "http://localhost:9009/api/config/categories/772", 
      "type": "application/vnd.abiquo.category+json", 
      "rel": "category", 
      "title": "48"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/2218/datacenterrepositories/1442/virtualmachinetemplates/805", 
      "type": "application/vnd.abiquo.virtualmachinetemplate+json", 
      "rel": "edit", 
      "title": "persistent"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/2218/datacenterrepositories/1442/virtualmachinetemplates/805/tasks", 
      "type": "application/vnd.abiquo.tasks+json", 
      "rel": "tasks", 
      "title": "tasks"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/2218/datacenterrepositories/1442", 
      "type": "application/vnd.abiquo.datacenterrepository+json", 
      "rel": "datacenterrepository", 
      "title": "repository"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/2218/datacenterrepositories/1442/virtualmachinetemplates/805/action/virtualmachines", 
      "type": "application/vnd.abiquo.virtualmachines+json", 
      "rel": "virtualmachines", 
      "title": "virtual machines"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/2218/datacenterrepositories/1442/virtualmachinetemplates/803", 
      "type": "application/vnd.abiquo.virtualmachinetemplate+json", 
      "rel": "master", 
      "title": "20"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/2218/datacenterrepositories/1442/virtualmachinetemplates/805/disks", 
      "type": "application/vnd.abiquo.disks+json", 
      "rel": "disks", 
      "title": "disks"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/2218/datacenterrepositories/1442/virtualmachinetemplates/805/disks/753", 
      "type": "application/vnd.abiquo.disk+json", 
      "rel": "disk0"
    }, 
    {
      "href": "http://50", 
      "rel": "templatedefinition", 
      "title": "template definition"
    }, 
    {
      "href": "http://localhost:8080/am/erepos/2218/templates/not-in-repository-805", 
      "rel": "templatePath", 
      "title": "template path"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/2218/datacenterrepositories/1442/virtualmachinetemplates/805/action/move", 
      "type": "application/vnd.abiquo.links+json", 
      "rel": "move", 
      "title": "persistent"
    }
  ], 
  "variables": {}, 
  "enableCpuHotAdd": false, 
  "creationUser": "-2052447688", 
  "ramRequired": 4, 
  "iconUrl": "http://validiconurl.com/icon.jpg", 
  "enableRemoteAccessHotReconfigure": false, 
  "enableDisksHotReconfigure": false, 
  "osType": "DEBIAN_64", 
  "creationDate": "2017-12-05T15:24:40.000+0000", 
  "id": "805", 
  "enableOnlyHPRecommended": false, 
  "chefEnabled": false, 
  "name": "persistent", 
  "state": "DONE", 
  "enableNicsHotReconfigure": false, 
  "enableRamHotAdd": false, 
  "shared": false, 
  "cpuRequired": 1, 
  "generateGuestInitialPassword": false
}

Synchronize  location

This method allows to synchronize  a location from  cloud provider region that not support VPC

Retrieves all the entities: networks, firewalls, loadBalancers and virtual machines.  

For each entity and related components, check if exist already a virtualDatacenter containing one of the entity to synchronize all in this VDC.

In case doesn't exist a default virtualDatacenter will be created

Synopsis: POST http://example.com/api/cloud/ locations/{publiccloudregions}/action/sync
Roles Required: VDC_ENUMERATE
Request Headers: Accept:  Content-type: 
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: TaskExtended Media Type
Request Example:

 

Retrieve a Task

Displays a specific Task on the Location. Tasks are a set of jobs. Any of these Tasks may still be in progress. Every Task has a UUID.

Synopsis: GET  http://example.com/api/cloud/locations/{publiccloudregions}/tasks/{id}
Roles Required: VDC_ENUMERATE
Request Headers: Accept:  application/vnd.abiquo.task+json; version=4.4; application/vnd.abiquo.task+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: Task Media Type
Request Example:

 Click here to show or hide the request example

 


GET_cld_locs_X_tsks_X_AC_tsk_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1/tasks/5bfccf55-a92c-497f-a49b-0c6a3d201237\ 
	 -H 'Accept:application/vnd.abiquo.task+json; version=3.10' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
   "timestamp" : 1480684851,
   "ownerId" : "1",
   "userId" : "1",
   "links" : [
      {
         "href" : "http://localhost:9000/api/cloud/locations/1/tasks/5bfccf55-a92c-497f-a49b-0c6a3d201237",
         "rel" : "self"
      },
      {
         "rel" : "parent",
         "href" : "http://localhost:9000/api/cloud/locations/1/tasks"
      }
   ],
   "type" : "SYNC_PCR",
   "creationTimestamp" : 1480684844,
   "state" : "FINISHED_SUCCESSFULLY",
   "taskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
   "jobs" : {
      "links" : [],
      "collection" : [
         {
            "links" : [],
            "description" : "",
            "state" : "DONE",
            "creationTimestamp" : 1480684844,
            "type" : "PRIVATE_NETWORKS",
            "parentTaskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
            "id" : "7ad4d456-1be2-4e80-9637-9410672c80e9",
            "rollbackState" : "UNKNOWN",
            "timestamp" : 1480684845
         },
         {
            "rollbackState" : "UNKNOWN",
            "timestamp" : 1480684847,
            "id" : "e6ac3fad-d146-43e4-9f85-2ef3d15358e4",
            "links" : [],
            "description" : "",
            "creationTimestamp" : 1480684844,
            "state" : "DONE",
            "parentTaskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
            "type" : "FLOATING_IPS"
         },
         {
            "id" : "0bd24450-a88d-4837-9fad-79e175f30ecb",
            "state" : "DONE",
            "creationTimestamp" : 1480684844,
            "parentTaskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
            "type" : "FIREWALLS",
            "description" : "",
            "links" : [],
            "timestamp" : 1480684848,
            "rollbackState" : "UNKNOWN"
         },
         {
            "links" : [],
            "type" : "VIRTUAL_MACHINES",
            "creationTimestamp" : 1480684844,
            "state" : "DONE",
            "parentTaskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
            "description" : "",
            "id" : "53d03d48-f52a-461c-aa02-1b166d064de4",
            "timestamp" : 1480684848,
            "rollbackState" : "UNKNOWN"
         },
         {
            "id" : "11b3fb5e-4b7d-4e56-8b87-597027745a73",
            "state" : "DONE",
            "creationTimestamp" : 1480684844,
            "parentTaskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
            "type" : "LOAD_BALANCERS",
            "description" : "",
            "links" : [],
            "rollbackState" : "UNKNOWN",
            "timestamp" : 1480684851
         }
      ]
   }
}

List tasks for this location

Displays the Tasks on the Location. Tasks are a set of jobs. Any of these Tasks may still be in progress.

Synopsis: GET http://example.com/api/cloud/ locations/{publiccloudregions}/tasks
Roles Required: VDC_ENUMERATE
Request Headers: Accept:  application/vnd.abiquo.tasks+json; version=4.4; application/vnd.abiquo.tasks+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: Tasks Media Type
Request Example:

 Click here to show or hide the request example


GET_cld_locs_X_tsks_X_AC_tsk_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1/tasks/5bfccf55-a92c-497f-a49b-0c6a3d201237\ 
	 -H 'Accept:application/vnd.abiquo.task+json; version=3.10' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
   "timestamp" : 1480684851,
   "ownerId" : "1",
   "userId" : "1",
   "links" : [
      {
         "href" : "http://localhost:9000/api/cloud/locations/1/tasks/5bfccf55-a92c-497f-a49b-0c6a3d201237",
         "rel" : "self"
      },
      {
         "rel" : "parent",
         "href" : "http://localhost:9000/api/cloud/locations/1/tasks"
      }
   ],
   "type" : "SYNC_PCR",
   "creationTimestamp" : 1480684844,
   "state" : "FINISHED_SUCCESSFULLY",
   "taskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
   "jobs" : {
      "links" : [],
      "collection" : [
         {
            "links" : [],
            "description" : "",
            "state" : "DONE",
            "creationTimestamp" : 1480684844,
            "type" : "PRIVATE_NETWORKS",
            "parentTaskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
            "id" : "7ad4d456-1be2-4e80-9637-9410672c80e9",
            "rollbackState" : "UNKNOWN",
            "timestamp" : 1480684845
         },
         {
            "rollbackState" : "UNKNOWN",
            "timestamp" : 1480684847,
            "id" : "e6ac3fad-d146-43e4-9f85-2ef3d15358e4",
            "links" : [],
            "description" : "",
            "creationTimestamp" : 1480684844,
            "state" : "DONE",
            "parentTaskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
            "type" : "FLOATING_IPS"
         },
         {
            "id" : "0bd24450-a88d-4837-9fad-79e175f30ecb",
            "state" : "DONE",
            "creationTimestamp" : 1480684844,
            "parentTaskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
            "type" : "FIREWALLS",
            "description" : "",
            "links" : [],
            "timestamp" : 1480684848,
            "rollbackState" : "UNKNOWN"
         },
         {
            "links" : [],
            "type" : "VIRTUAL_MACHINES",
            "creationTimestamp" : 1480684844,
            "state" : "DONE",
            "parentTaskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
            "description" : "",
            "id" : "53d03d48-f52a-461c-aa02-1b166d064de4",
            "timestamp" : 1480684848,
            "rollbackState" : "UNKNOWN"
         },
         {
            "id" : "11b3fb5e-4b7d-4e56-8b87-597027745a73",
            "state" : "DONE",
            "creationTimestamp" : 1480684844,
            "parentTaskId" : "5bfccf55-a92c-497f-a49b-0c6a3d201237",
            "type" : "LOAD_BALANCERS",
            "description" : "",
            "links" : [],
            "rollbackState" : "UNKNOWN",
            "timestamp" : 1480684851
         }
      ]
   }
}

List floating IPs for a location

Returns the list of all floating IPs available to an enterprise in a location.

Synopsis: GET http://example.com/api/cloud/locations/{location}/ips 
Roles Required: ROLE_MANAGE_FLOATINGIPS
Request Headers: Accept:  application/vnd.abiquo.publicips+json; version=4.4; application/vnd.abiquo.publicips+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: Abiquo Data Media Types#PublicIPs Media Type 
Request Example:

 Click here to show or hide the request example

GET_cld_locs_X_ips_AC_pubips_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/2180/ips \ 
	 -H 'Accept:application/vnd.abiquo.publicips+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 0, 
  "links": [], 
  "collection": []
}


Reserve a floating IP in a location

Reserves a floating IP for an enterprise in a location. Optionally send a link to a virtual datacenter that will use the floating IP 

Synopsis: POST http://example.com/api/cloud/locations/{location}/ips 
Roles Required: MANAGE_FLOATINGIPS
Request Headers: Accept:  application/vnd.abiquo.publicip+json; version=4.4; application/vnd.abiquo.publicip+xml; version=4.4;  Content-type: application/vnd.abiquo.links+json; version=4.4; application/vnd.abiquo.links+xml; version=4.4; ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: Abiquo Data Media Types#Links Media Type 
Response Message Body Entity: Abiquo Data Media Types#PublicIP Media Type 
Request Example:

 Click here to show or hide the request example

POST_cld_locs_X_ips_CT_lnks_j_AC_pubip_j.0001.txt

cURL:

curl -X POST http://localhost:9000/api/cloud/locations/2106/ips \ 
	 -H 'Accept:application/vnd.abiquo.publicip+json; version=4.2' \ 
	 -H 'Content-Type:application/vnd.abiquo.links+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 201

Request payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/1516", 
      "rel": "virtualdatacenter"
    }
  ]
}

Response payload:

{
  "available": true, 
  "providerId": "D1DE259DB646EBDAA121", 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations/2106", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "location", 
      "title": "185"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/2106/ips/2079", 
      "type": "application/vnd.abiquo.publicip+json", 
      "rel": "self", 
      "title": "192.168.171.137"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/1516", 
      "type": "application/vnd.abiquo.virtualdatacenter+json", 
      "rel": "virtualdatacenter", 
      "title": "200"
    }
  ], 
  "ipv6": false, 
  "ip": "192.168.171.137", 
  "quarantine": false, 
  "id": 2079
}

Get a floating IP in a location

Returns a floating IP available to an enterprise in a location

Synopsis: GET http://example.com/api/cloud/locations/{location}/ips/{publicip} 
Roles Required: MANAGE_FLOATINGIPS 
Request Headers: Accept:  application/vnd.abiquo.publicips+json; version=4.4; application/vnd.abiquo.publicips+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: Abiquo Data Media Types#PublicIPs Media Type 
Request Example:

 Click here to show or hide the request example

GET_cld_locs_X_ips_X_AC_pubip_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1849/ips/1773 \ 
	 -H 'Accept:application/vnd.abiquo.publicip+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "available": true, 
  "providerId": "-1580905073", 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations/1849", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "location", 
      "title": "21"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1849/ips/1773", 
      "type": "application/vnd.abiquo.publicip+json", 
      "rel": "self", 
      "title": "0.190.160.230"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/1464", 
      "type": "application/vnd.abiquo.virtualdatacenter+json", 
      "rel": "virtualdatacenter", 
      "title": "29"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/1464/virtualappliances/655", 
      "type": "application/vnd.abiquo.virtualappliance+json", 
      "rel": "virtualappliance", 
      "title": "35"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/1464/virtualappliances/655/virtualmachines/634", 
      "type": "application/vnd.abiquo.virtualmachine+json", 
      "rel": "virtualmachine", 
      "title": "42"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/1464/virtualappliances/655/virtualmachines/634", 
      "type": "application/vnd.abiquo.virtualmachine+json", 
      "rel": "virtualmachine", 
      "title": "42"
    }
  ], 
  "ipv6": false, 
  "ip": "0.190.160.230", 
  "quarantine": false, 
  "id": 1773
}

Remove a floating IP from a location

Removes a floating IP that was reserved by an enterprise in a location

Synopsis: DELETE http://example.com/api/cloud/locations/{location}/ips/{publicip
Roles Required: MANAGE_FLOATINGIPS 
Request Headers: Accept:  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: 
Request Example:

 Click here to show or hide the request example

DELETE_cld_locs_X_ips_X.0001.txt

cURL:

curl -X DELETE http://localhost:9000/api/cloud/locations/1894/ips/1838 \ 
	 -H 'Accept:text/json,application/json' \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

--none--

Response payload:

--none--

List devices for a location

Returns the list of all devices available to an enterprise in a location. 

Synopsis: GET http://example.com/api/cloud/locations/{location}/devices 
Roles Required: VDC_ENUMERATE
Request Headers: Accept:  application/vnd.abiquo.devices+json; version=4.4; application/vnd.abiquo.devices+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: Abiquo Data Media Types#Devices Media Type 
Request Example:

 Click here to show or hide the request example

GET_cld_locs_X_devs_AC_devs_j.0003.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/2220/devices \ 
	 -H 'Accept:application/vnd.abiquo.devices+json; version=3.10' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 2, 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations/2220/devices?limit=25&by=name", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/2220/devices?startwith=0&limit=25&by=name", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "links": [
        {
          "href": "http://localhost:9009/api/cloud/locations/2220/devices/620", 
          "type": "application/vnd.abiquo.device+json", 
          "rel": "edit", 
          "title": "devicetype-device"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/2220", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "location", 
          "title": "308"
        }, 
        {
          "href": "http://localhost:9009/api/config/devicetypes/devicetype", 
          "type": "application/vnd.abiquo.devicetype+json", 
          "rel": "devicetype", 
          "title": "devicetype"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/2220/devices/620/virtualdatacenters", 
          "type": "application/vnd.abiquo.virtualdatacenters+json", 
          "rel": "virtualdatacenters", 
          "title": "virtualdatacenters"
        }
      ], 
      "endpoint": "314", 
      "name": "devicetype-device", 
      "vdcDefault": false, 
      "description": "devicetype Device"
    }, 
    {
      "links": [
        {
          "href": "http://localhost:9009/api/cloud/locations/2220/devices/621", 
          "type": "application/vnd.abiquo.device+json", 
          "rel": "edit", 
          "title": "devicetype-device"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/2220", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "location", 
          "title": "308"
        }, 
        {
          "href": "http://localhost:9009/api/config/devicetypes/devicetype", 
          "type": "application/vnd.abiquo.devicetype+json", 
          "rel": "devicetype", 
          "title": "devicetype"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/2220/devices/621/virtualdatacenters", 
          "type": "application/vnd.abiquo.virtualdatacenters+json", 
          "rel": "virtualdatacenters", 
          "title": "virtualdatacenters"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/2350", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "292"
        }
      ], 
      "endpoint": "317", 
      "name": "devicetype-device", 
      "vdcDefault": false, 
      "description": "devicetype Device"
    }
  ]
}


Get a device in a location

Returns a device available to an enterprise in a location. To work with devices, see the subresources such as DeviceNetworksResource

Synopsis: GET http://example.com/api/cloud/locations/{location}/devices/{device
Roles Required: VDC_ENUMERATE 
Request Headers: Accept:  application/vnd.abiquo.device+json; version=4.4; application/vnd.abiquo.device+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: Abiquo Data Media Types#Device Media Type 
Request Example:

 Click here to show or hide the request example

GET_cld_locs_X_devs_X_AC_dev_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1476/devices/101 \ 
	 -H 'Accept:application/vnd.abiquo.device+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations/1476/devices/101", 
      "type": "application/vnd.abiquo.device+json", 
      "rel": "self", 
      "title": "devicetype-device"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1476", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "location", 
      "title": "16"
    }, 
    {
      "href": "http://localhost:9009/api/config/devicetypes/devicetype", 
      "type": "application/vnd.abiquo.devicetype+json", 
      "rel": "devicetype", 
      "title": "devicetype"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/1476/devices/101/virtualdatacenters", 
      "type": "application/vnd.abiquo.virtualdatacenters+json", 
      "rel": "virtualdatacenters", 
      "title": "virtualdatacenters"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/2274", 
      "type": "application/vnd.abiquo.enterprise+json", 
      "rel": "enterprise", 
      "title": "0"
    }
  ], 
  "endpoint": "22", 
  "name": "devicetype-device", 
  "vdcDefault": false, 
  "description": "devicetype Device"
}

List backup policies for a location

Returns the list of all backup policies available to an enterprise in a location. To manage backups, see the backup resources for the datacenter such as BackupManagerResource

Synopsis: GET http://example.com/api/locations/{location}/backuppolicies 
Roles Required:  PHYS_DC_ALLOW_BACKUP_CONFIG,VAPP_MANAGE_BACKUP"
Request Headers: Accept:  application/vnd.abiquo.backuppolicies+json; version=4.4; application/vnd.abiquo.backuppolicies+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: Abiquo Data Media Types#BackupPolicies Media Type 
Request Example:

 Click here to show or hide the request example

GET_cld_locs_X_bkppolicies_AC_bkppolicies_j.0004.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/5035/backuppolicies \ 
	 -H 'Accept:application/vnd.abiquo.backuppolicies+json; version=3.10' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 0, 
  "links": [], 
  "collection": []
}


Get a backup policy in a location

Returns a backup policy available to an enterprise in a location. To manage backups, see the backup resources for the datacenter such as BackupManagerResource

Synopsis: GET http://example.com/api/cloud/locations/{location}/backuppolicies/{backuppolicy} 
Roles Required:  PHYS_DC_ALLOW_BACKUP_CONFIG,VAPP_MANAGE_BACKUP
Request Headers: Accept:  application/vnd.abiquo.backuppolicy+json; version=4.4; application/vnd.abiquo.backuppolicy+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: Abiquo Data Media Types#BackupPolicy Media Type 
Request Example:

 Click here to show or hide the request example

GET_cld_locs_X_bkppolicies_X_AC_bkppolicy_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/locations/1375/backuppolicies/25 \ 
	 -H 'Accept:application/vnd.abiquo.backuppolicy+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "code": "code", 
  "backupConfigurations": [], 
  "name": "name", 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/locations/1375/backuppolicies/25", 
      "type": "application/vnd.abiquo.backuppolicy+json", 
      "rel": "edit", 
      "title": "name"
    }
  ]
}

List backup properties for a location

Returns the list of all backup properties set for an enterprise in a location. To manage backups, see the backup resources for the datacenter such as BackupManagerResource

Synopsis: GET http://example.com/api/cloud/locations/{location}/backupproperties 
Roles Required:  VAPP_MANAGE_BACKUP"
Request Headers: Accept:  application/vnd.abiquo.backupdatacenterproperties+json; version=4.4; application/vnd.abiquo.backupdatacenterproperties+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: Abiquo Data Media Types#BackupDatacenterProperties Media Type 
Request Example:

 Click here to show or hide the request example

Create example