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:

Public Cloud Region Resource

A Public Cloud Region is the representation of a public cloud provider region in Abiquo. For example, this resource can be used to create and manage public cloud provider regions in Amazon and Azure, as well as provider VDCs or Organization VDCs in vCloud Director.

Main URI of the Resource

This class operates mainly over the Resource URI: /admin/publiccloudregions

Exposed Methods

Create a public cloud region

You must create a public cloud region with a set of remote services, these can be remote services already existent or remote services to create in the same request than the public cloud region. If they already exist the public cloud region DTO must have the links of these remote services with rel 'remoteservice', but if they want to be created they must be filled as a remote service DTO in the remote services attribute of the public cloud region DTO.

If the public cloud region refers to a generic cloud provider, such as a generic OpenStack installation, then the following additional headers have to be added to the request, in order to provide the information needed to retrieve the list of available regions. Note that the information provided in these headers will not be stored and will only be used to get the list of available regions.

HeaderValue

X-Abiquo-PCR-Identity

The identity to use when connecting to the cloud provider to get the available regions.

X-Abiquo-PCR-Credential

The identity to use when connecting to the cloud provider to get the available regions.

X-Abiquo-PCR-Endpoint

The endpoint to connect to get the list of available regions.

If some error occurs the response will contain configuration errors but the public cloud region will be created.

Synopsis: POST http://example.com/api/admin/publiccloudregions
Roles Required: PHYS_DC_MANAGE
Request Headers: Accept: application/vnd.abiquo.publiccloudregions+json; version=4.4; application/vnd.abiquo.publiccloudregions+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

Request example:

 Click here to show or hide the request example

POST_adm_pubcldregs_CT_pubcldreg_j_AC_pubcldreg_j.0001.txt

cURL:

curl -X POST http://localhost:9000/api/admin/publiccloudregions \ 
	 -H 'Accept:application/vnd.abiquo.publiccloudregion+json; version=4.2' \ 
	 -H 'Content-Type:application/vnd.abiquo.publiccloudregion+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 201

Request payload:

{
  "remoteServices": {
    "links": [], 
    "collection": [
      {
        "status": 0, 
        "type": "CLOUD_PROVIDER_PROXY", 
        "uri": "http://localhost:80/check", 
        "links": []
      }
    ]
  }, 
  "name": "pcr", 
  "links": [
    {
      "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST/regions/region", 
      "rel": "region"
    }, 
    {
      "href": "http://localhost:9009/api/admin/remoteservices/943", 
      "rel": "remoteservice"
    }, 
    {
      "href": "http://localhost:9009/api/admin/remoteservices/945", 
      "rel": "remoteservice"
    }, 
    {
      "href": "http://localhost:9009/api/admin/remoteservices/946", 
      "rel": "remoteservice"
    }, 
    {
      "href": "http://localhost:9009/api/admin/remoteservices/952", 
      "rel": "remoteservice"
    }
  ]
}

Response payload:

{
  "remoteServices": {
    "links": [], 
    "collection": [
      {
        "status": 1, 
        "uuid": "remoteserviceuuid", 
        "links": [
          {
            "href": "http://localhost:9009/api/admin/remoteservices/953", 
            "type": "application/vnd.abiquo.remoteservice+json", 
            "rel": "edit", 
            "title": "CLOUDPROVIDERPROXY"
          }, 
          {
            "href": "http://localhost:9009/api/admin/remoteservices/953/action/check", 
            "type": "", 
            "rel": "check", 
            "title": "check"
          }, 
          {
            "href": "http://localhost:9009/api/admin/publiccloudregions/156", 
            "type": "application/vnd.abiquo.publiccloudregion+json", 
            "rel": "publiccloudregion", 
            "title": "pcr"
          }
        ], 
        "type": "CLOUD_PROVIDER_PROXY", 
        "uri": "http://localhost:80/check", 
        "id": 953
      }, 
      {
        "status": 1, 
        "uuid": "remoteserviceuuid", 
        "links": [
          {
            "href": "http://localhost:9009/api/admin/remoteservices/943", 
            "type": "application/vnd.abiquo.remoteservice+json", 
            "rel": "edit", 
            "title": "VIRTUALFACTORY"
          }, 
          {
            "href": "http://localhost:9009/api/admin/remoteservices/943/action/check", 
            "type": "", 
            "rel": "check", 
            "title": "check"
          }, 
          {
            "href": "http://localhost:9009/api/admin/datacenters/155", 
            "type": "application/vnd.abiquo.datacenter+json", 
            "rel": "datacenter", 
            "title": "datacenter"
          }, 
          {
            "href": "http://localhost:9009/api/admin/publiccloudregions/156", 
            "type": "application/vnd.abiquo.publiccloudregion+json", 
            "rel": "publiccloudregion", 
            "title": "pcr"
          }
        ], 
        "type": "VIRTUAL_FACTORY", 
        "uri": "http://localhost:8080/virtualfactory", 
        "id": 943
      }, 
      {
        "status": 1, 
        "uuid": "remoteserviceuuid", 
        "links": [
          {
            "href": "http://localhost:9009/api/admin/remoteservices/945", 
            "type": "application/vnd.abiquo.remoteservice+json", 
            "rel": "edit", 
            "title": "VIRTUALSYSTEMMONITOR"
          }, 
          {
            "href": "http://localhost:9009/api/admin/remoteservices/945/action/check", 
            "type": "", 
            "rel": "check", 
            "title": "check"
          }, 
          {
            "href": "http://localhost:9009/api/admin/datacenters/155", 
            "type": "application/vnd.abiquo.datacenter+json", 
            "rel": "datacenter", 
            "title": "datacenter"
          }, 
          {
            "href": "http://localhost:9009/api/admin/publiccloudregions/156", 
            "type": "application/vnd.abiquo.publiccloudregion+json", 
            "rel": "publiccloudregion", 
            "title": "pcr"
          }
        ], 
        "type": "VIRTUAL_SYSTEM_MONITOR", 
        "uri": "http://localhost:8080/vsm", 
        "id": 945
      }, 
      {
        "status": 1, 
        "uuid": "remoteserviceuuid", 
        "links": [
          {
            "href": "http://localhost:9009/api/admin/remoteservices/946", 
            "type": "application/vnd.abiquo.remoteservice+json", 
            "rel": "edit", 
            "title": "NODECOLLECTOR"
          }, 
          {
            "href": "http://localhost:9009/api/admin/remoteservices/946/action/check", 
            "type": "", 
            "rel": "check", 
            "title": "check"
          }, 
          {
            "href": "http://localhost:9009/api/admin/datacenters/155", 
            "type": "application/vnd.abiquo.datacenter+json", 
            "rel": "datacenter", 
            "title": "datacenter"
          }, 
          {
            "href": "http://localhost:9009/api/admin/publiccloudregions/156", 
            "type": "application/vnd.abiquo.publiccloudregion+json", 
            "rel": "publiccloudregion", 
            "title": "pcr"
          }
        ], 
        "type": "NODE_COLLECTOR", 
        "uri": "http://localhost:8080/nodecollector", 
        "id": 946
      }, 
      {
        "status": 1, 
        "type": "REMOTE_ACCESS", 
        "id": 952, 
        "links": [
          {
            "href": "http://localhost:9009/api/admin/remoteservices/952", 
            "type": "application/vnd.abiquo.remoteservice+json", 
            "rel": "edit", 
            "title": "REMOTEACCESS"
          }, 
          {
            "href": "http://localhost:9009/api/admin/datacenters/155", 
            "type": "application/vnd.abiquo.datacenter+json", 
            "rel": "datacenter", 
            "title": "datacenter"
          }, 
          {
            "href": "http://localhost:9009/api/admin/publiccloudregions/156", 
            "type": "application/vnd.abiquo.publiccloudregion+json", 
            "rel": "publiccloudregion", 
            "title": "pcr"
          }
        ], 
        "uri": "http://localhost:8080/guacd"
      }
    ]
  }, 
  "id": 156, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/156", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "edit", 
      "title": "pcr"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/156/enterprises", 
      "type": "application/vnd.abiquo.enterprises+json", 
      "rel": "enterprises", 
      "title": "enterprises"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/156/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/admin/publiccloudregions/156/hardwareprofiles", 
      "type": "application/vnd.abiquo.hardwareprofiles+json", 
      "rel": "hardwareprofiles", 
      "title": "hardware profiles public cloud region"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/156/hardwareprofiles/action/sync", 
      "type": "", 
      "rel": "synchardwareprofiles", 
      "title": "sync hardware profiles"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/156", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "location", 
      "title": "pcr"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/156/metrics", 
      "type": "application/vnd.abiquo.metricsmetadata+json", 
      "rel": "metricsmetadata", 
      "title": "metricsmetadata"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/156/metrics/collectd", 
      "type": "application/json", 
      "rel": "collectd", 
      "title": "collectd"
    }
  ], 
  "name": "pcr"
}


Request body example:

 Click here to show or hide the request body
Example of request body
<publiccloudregion>
	<link rel="region" href="http://example.com/api/config/hypervisortypes/AMAZON/regions/eu-west-1"/>
	<link rel="remoteservice" href="http://example.com/api/admin/remoteservices/1" title="NODECOLLECTOR"/>
	<name>eu-west-1</name>
	<uuid>DatacenterUUID</uuid>
	<remoteServices>
	    <remoteService>
    	    <type>VIRTUAL_SYSTEM_MONITOR</type>
        	<uri>http://example.com/vsm</uri>
	    </remoteService>
    	<remoteService>
        	<type>VIRTUAL_FACTORY</type>
	        <uri>http://example.com/virtualfactory</uri>
    	</remoteService>
	    <remoteService>
    	    <type>CLOUD_PROVIDER_PROXY</type>
        	<uri>http://example.com/cpp</uri>
	    </remoteService>
	</remoteServices>
</publiccloudregion>


Request Example:

 Click here to show or hide the request example
Example of public cloud region creation
curl -X POST http://example.com/api/admin/publiccloudregions \
	 -H 'content-tye:application/vnd.abiquo.publiccloudregions+xml;version=3.0' \
	 -H 'accept:application/vnd.abiquo.publiccloudregions+xml;version=3.0' \
	 -d @entity.xml \
	 -u user:password --verbose


POST /api/admin/publiccloudregions HTTP/1.1
content-tye:application/vnd.abiquo.publiccloudregions+xml;version=3.0
accept:application/vnd.abiquo.publiccloudregions+xml;version=3.0
 
 
HTTP/1.1 200 OK
Content-Type: application/vnd.abiquo.publiccloudregions+xml;version=3.0


 
<publiccloudregion>
	<link title="eu-west-1" rel="edit" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
	<link title="eu-west-1" rel="remoteservices" type="application/vnd.abiquo.remoteservices+xml" href="http://example.com/api/admin/publiccloudregions/1/remoteservices"/>
	<link title="Amazon" rel="hypervisortype" type="application/vnd.abiquo.hypervisortype+xml" href="http://example.com/api/config/hypervisortypes/AMAZON"/>
	<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"/>
	<id>1</id>
	<name>eu-west-1</name>
	<uuid>DatacenterUUID</uuid>
	<remoteServices>
		<remoteService>
        	<link title="eu-west-1" rel="publiccloudregion" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
	        <link title="check" rel="check" href="http://example.com/api/admin/remoteservices/1/action/check"/>
    	    <link title="NODE_COLLECTOR" rel="edit" type="application/vnd.abiquo.remoteservice+xml" href="http://example.com/api/admin/remoteservices/1"/>
        	<id>1</id>
	        <type>NODE_COLLECTOR</type>
    	    <uri>http://example.com/nodecollector</uri>
        	<status>1</status>
	    </remoteService>
    	<remoteService>
        	<link title="eu-west-1" rel="publiccloudregion" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
	        <link title="check" rel="check" href="http://example.com/api/admin/remoteservices/2/action/check"/>
    	    <link title="VIRTUAL_SYSTEM_MONITOR" rel="edit" type="application/vnd.abiquo.remoteservice+xml" href="http://example.com/api/admin/remoteservices/2"/>
	        <id>2</id>
    	    <type>VIRTUAL_SYSTEM_MONITOR</type>
        	<uri>http://example.com/vsm</uri>
	        <status>1</status>
    	</remoteService>
	    <remoteService>
    	    <link title="eu-west-1" rel="publiccloudregion" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
	        <link title="check" rel="check" href="http://example.com/api/admin/remoteservices/3/action/check"/>
        	<link title="VIRTUAL_FACTORY" rel="edit" type="application/vnd.abiquo.remoteservice+xml" href="http://example.com/api/admin/remoteservices/3"/>
    	    <id>3</id>
        	<type>VIRTUAL_FACTORY</type>
	        <uri>http://example.com/virtualfactory</uri>
    	    <status>1</status>
	    </remoteService>
	    <remoteService>
    	    <link title="eu-west-1" rel="publiccloudregion" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
        	<link title="check" rel="check" href="http://example.com/api/admin/remoteservices/4/action/check"/>
	        <link title="CLOUD_PROVIDER_PROXY" rel="edit" type="application/vnd.abiquo.remoteservice+xml" href="http://example.com/api/admin/remoteservices/4"/>
    	    <id>4</id>
        	<type>CLOUD_PROVIDER_PROXY</type>
	        <uri>http://example.com/cpp</uri>
    	    <status>1</status>
	    </remoteService>
</publiccloudregion>

List public cloud regions

Return the list of all public cloud regions, which can be filtered by enterprise or scope.

Synopsis: GET http://example.com/api/admin/publiccloudregions
Roles Required: PHYS_DC_ENUMERATE,VDC_MANAGE,USERS_MANAGE_ENTERPRISE,PRICING_VIEW,APPLIB_VIEW,USERS_VIEW 
Request Headers: Accept: application/vnd.abiquo.publiccloudregions+json; version=4.4; application/vnd.abiquo.publiccloudregions+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

idEnterprise

false

 

identifier of an enterprise

idScope

false

 

identifier of a scope

 

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_adm_pubcldregs_AC_pubcldregs_j.0001.txt

cURL:

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

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 4, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions?limit=25&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions?startwith=0&limit=25&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "id": 806, 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/806", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "edit", 
          "title": "name0"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/806/enterprises", 
          "type": "application/vnd.abiquo.enterprises+json", 
          "rel": "enterprises", 
          "title": "enterprises"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/806/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/regionA", 
          "type": "application/vnd.abiquo.region+json", 
          "rel": "region", 
          "title": "regionA"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/806/hardwareprofiles", 
          "type": "application/vnd.abiquo.hardwareprofiles+json", 
          "rel": "hardwareprofiles", 
          "title": "hardware profiles public cloud region"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/806/hardwareprofiles/action/sync", 
          "type": "", 
          "rel": "synchardwareprofiles", 
          "title": "sync hardware profiles"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/806", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "location", 
          "title": "name0"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/806/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/806/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }
      ], 
      "name": "name0"
    }, 
    {
      "id": 807, 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/807", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "edit", 
          "title": "name1"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/807/enterprises", 
          "type": "application/vnd.abiquo.enterprises+json", 
          "rel": "enterprises", 
          "title": "enterprises"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/807/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/regionB", 
          "type": "application/vnd.abiquo.region+json", 
          "rel": "region", 
          "title": "regionB"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/807/hardwareprofiles", 
          "type": "application/vnd.abiquo.hardwareprofiles+json", 
          "rel": "hardwareprofiles", 
          "title": "hardware profiles public cloud region"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/807/hardwareprofiles/action/sync", 
          "type": "", 
          "rel": "synchardwareprofiles", 
          "title": "sync hardware profiles"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/807", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "location", 
          "title": "name1"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/807/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/807/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }
      ], 
      "name": "name1"
    }, 
    {
      "id": 808, 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/808", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "edit", 
          "title": "name2"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/808/enterprises", 
          "type": "application/vnd.abiquo.enterprises+json", 
          "rel": "enterprises", 
          "title": "enterprises"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/808/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/regionC", 
          "type": "application/vnd.abiquo.region+json", 
          "rel": "region", 
          "title": "regionC"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/808/hardwareprofiles", 
          "type": "application/vnd.abiquo.hardwareprofiles+json", 
          "rel": "hardwareprofiles", 
          "title": "hardware profiles public cloud region"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/808/hardwareprofiles/action/sync", 
          "type": "", 
          "rel": "synchardwareprofiles", 
          "title": "sync hardware profiles"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/808", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "location", 
          "title": "name2"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/808/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/808/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }
      ], 
      "name": "name2"
    }, 
    {
      "id": 809, 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/809", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "edit", 
          "title": "name3"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/809/enterprises", 
          "type": "application/vnd.abiquo.enterprises+json", 
          "rel": "enterprises", 
          "title": "enterprises"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/809/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/regionD", 
          "type": "application/vnd.abiquo.region+json", 
          "rel": "region", 
          "title": "regionD"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/809/hardwareprofiles", 
          "type": "application/vnd.abiquo.hardwareprofiles+json", 
          "rel": "hardwareprofiles", 
          "title": "hardware profiles public cloud region"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/809/hardwareprofiles/action/sync", 
          "type": "", 
          "rel": "synchardwareprofiles", 
          "title": "sync hardware profiles"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/809", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "location", 
          "title": "name3"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/809/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/809/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }
      ], 
      "name": "name3"
    }
  ]
}

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


GET http://example.com/api/admin/publiccloudregions 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/admin/publiccloudregions?limit=25"/>
    <link rel="last" href="http://example.com/api/admin/publiccloudregions?startwith=0&amp;limit=25"/>
    <totalSize>1</totalSize>
    <publiccloudregion>
        <link title="eu-west-1" rel="edit" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
        <link title="eu-west-1" rel="remoteservices" type="application/vnd.abiquo.remoteservices+xml" href="http://example.com/api/admin/publiccloudregions/1/remoteservices"/>
        <link title="Amazon" rel="hypervisortype" type="application/vnd.abiquo.hypervisortype+xml" href="http://example.com/api/config/hypervisortypes/AMAZON"/>
        <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"/>
        <id>1</id>
        <name>eu-west-1</name>
        <uuid>DatacenterUUID</uuid>
    </publiccloudregion>
</publiccloudregions>

Get a public cloud region

Return a public cloud region

Synopsis: GET http://example.com/api/admin/publiccloudregions/{publiccloudregion}
Roles Required:  PHYS_DC_ENUMERATE,USERS_MANAGE_ENTERPRISE, APPLIB_ALLOW_MODIFY 
Request Headers: Accept: application/vnd.abiquo.publiccloudregion+json; version=4.4; application/vnd.abiquo.publiccloudregion+xml; version=4.4;  Content-type: ;
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_adm_pubcldregs_X_AC_pubcldreg_j.0001.txt

cURL:

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

Success status code: 200

Request payload:

--none--

Response payload:

{
  "id": 786, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/786", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "edit", 
      "title": "35"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/786/enterprises", 
      "type": "application/vnd.abiquo.enterprises+json", 
      "rel": "enterprises", 
      "title": "enterprises"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/786/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/32", 
      "type": "application/vnd.abiquo.region+json", 
      "rel": "region", 
      "title": "32"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/786/hardwareprofiles", 
      "type": "application/vnd.abiquo.hardwareprofiles+json", 
      "rel": "hardwareprofiles", 
      "title": "hardware profiles public cloud region"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/786/hardwareprofiles/action/sync", 
      "type": "", 
      "rel": "synchardwareprofiles", 
      "title": "sync hardware profiles"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/786", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "location", 
      "title": "35"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/786/metrics", 
      "type": "application/vnd.abiquo.metricsmetadata+json", 
      "rel": "metricsmetadata", 
      "title": "metricsmetadata"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/786/metrics/collectd", 
      "type": "application/json", 
      "rel": "collectd", 
      "title": "collectd"
    }
  ], 
  "name": "35"
}

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


GET http://example.com/api/admin/publiccloudregion 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="edit" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
	<link title="eu-west-1" rel="remoteservices" type="application/vnd.abiquo.remoteservices+xml" href="http://example.com/api/admin/publiccloudregions/1/remoteservices"/>
    <link title="Amazon" rel="hypervisortype" type="application/vnd.abiquo.hypervisortype+xml" href="http://example.com/api/config/hypervisortypes/AMAZON"/>
    <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"/>
    <id>1</id>
    <name>eu-west-1</name>
    <uuid>DatacenterUUID</uuid>
</publiccloudregion>

 

Update a public cloud region

Modify a public cloud region.

Synopsis: PUT http://example.com/api/admin/publiccloudregions/{publiclcoudregion} 
Roles Required: PHYS_DC_MANAGE 
Request Headers: Accept: application/vnd.abiquo.publiccloudregion+json; version=4.4; application/vnd.abiquo.publiccloudregion+xml; version=4.4;  Content-type:  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: Public Cloud Region Media Type 
Response Message Body Entity:  Public Cloud Region Media Type

  Request Example:

 

 Click here to show or hide the request example

PUT_adm_pubcldregs_X_CT_pubcldreg_j_AC_pubcldreg_j.0001.txt

cURL:

curl -X PUT http://localhost:9000/api/admin/publiccloudregions/789 \ 
	 -H 'Accept:application/xml, application/vnd.abiquo.publiccloudregion+json; version=4.2' \ 
	 -H 'Content-Type:application/vnd.abiquo.publiccloudregion+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

{
  "id": 789, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "edit", 
      "title": "Jaguar"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789/enterprises", 
      "type": "application/vnd.abiquo.enterprises+json", 
      "rel": "enterprises", 
      "title": "enterprises"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789/remoteservices", 
      "type": "application/vnd.abiquo.remoteservices+json", 
      "rel": "remoteservices", 
      "title": "remote services"
    }, 
    {
      "href": "http://localhost:9009/api/config/hypervisortypes/DYNAMIC_REGIONS", 
      "type": "application/vnd.abiquo.hypervisortype+json", 
      "rel": "hypervisortype", 
      "title": "DynamicRegionsProvider"
    }, 
    {
      "href": "http://localhost:9009/api/config/hypervisortypes/DYNAMIC_REGIONS/regions/region", 
      "type": "application/vnd.abiquo.region+json", 
      "rel": "region", 
      "title": "region"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789/hardwareprofiles", 
      "type": "application/vnd.abiquo.hardwareprofiles+json", 
      "rel": "hardwareprofiles", 
      "title": "hardware profiles public cloud region"
    }, 
    {
      "href": "http://localhost:9009/api/admin/remoteservices/1258", 
      "type": "application/vnd.abiquo.remoteservice+json", 
      "rel": "remoteservice", 
      "title": "CLOUDPROVIDERPROXY"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/789", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "location", 
      "title": "Jaguar"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789/metrics", 
      "type": "application/vnd.abiquo.metricsmetadata+json", 
      "rel": "metricsmetadata", 
      "title": "metricsmetadata"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789/metrics/collectd", 
      "type": "application/json", 
      "rel": "collectd", 
      "title": "collectd"
    }
  ], 
  "name": "Roadrunner"
}

Response payload:

{
  "id": 789, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "edit", 
      "title": "Roadrunner"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789/enterprises", 
      "type": "application/vnd.abiquo.enterprises+json", 
      "rel": "enterprises", 
      "title": "enterprises"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789/remoteservices", 
      "type": "application/vnd.abiquo.remoteservices+json", 
      "rel": "remoteservices", 
      "title": "remote services"
    }, 
    {
      "href": "http://localhost:9009/api/config/hypervisortypes/DYNAMIC_REGIONS", 
      "type": "application/vnd.abiquo.hypervisortype+json", 
      "rel": "hypervisortype", 
      "title": "DynamicRegionsProvider"
    }, 
    {
      "href": "http://localhost:9009/api/config/hypervisortypes/DYNAMIC_REGIONS/regions/region", 
      "type": "application/vnd.abiquo.region+json", 
      "rel": "region", 
      "title": "region"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789/hardwareprofiles", 
      "type": "application/vnd.abiquo.hardwareprofiles+json", 
      "rel": "hardwareprofiles", 
      "title": "hardware profiles public cloud region"
    }, 
    {
      "href": "http://localhost:9009/api/admin/remoteservices/1258", 
      "type": "application/vnd.abiquo.remoteservice+json", 
      "rel": "remoteservice", 
      "title": "CLOUDPROVIDERPROXY"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/789", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "location", 
      "title": "Roadrunner"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789/metrics", 
      "type": "application/vnd.abiquo.metricsmetadata+json", 
      "rel": "metricsmetadata", 
      "title": "metricsmetadata"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/789/metrics/collectd", 
      "type": "application/json", 
      "rel": "collectd", 
      "title": "collectd"
    }
  ], 
  "name": "Roadrunner"
}

Request body example:

 Click here to show or hide the request body
Example of request body
<publiccloudregion>
	<link rel="region" href="http://example.com/api/config/hypervisortypes/AMAZON/regions/eu-west-1"/>
	<name>eu-west-1-updated</name>
	<uuid>DatacenterUUID</uuid>
</publiccloudregion>


Request Example:

 Click here to show or hide the request example
Example of public cloud region update
curl -X POST http://example.com/api/admin/publiccloudregions \
	 -H 'content-tye:application/vnd.abiquo.publiccloudregion+xml;version=3.0' \
	 -H 'accept:application/vnd.abiquo.publiccloudregion+xml;version=3.0' \
	 -d @entity.xml \
	 -u user:password --verbose


POST /api/admin/publiccloudregions HTTP/1.1
content-tye:application/vnd.abiquo.publiccloudregion+xml;version=3.0
accept:application/vnd.abiquo.publiccloudregion+xml;version=3.0
 
 
HTTP/1.1 200 OK
Content-Type: application/vnd.abiquo.publiccloudregions+xml;version=3.0


 
<publiccloudregion>
	<link title="eu-west-1" rel="edit" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
	<link title="eu-west-1" rel="remoteservices" type="application/vnd.abiquo.remoteservices+xml" href="http://example.com/api/admin/publiccloudregions/1/remoteservices"/>
	<link title="Amazon" rel="hypervisortype" type="application/vnd.abiquo.hypervisortype+xml" href="http://example.com/api/config/hypervisortypes/AMAZON"/>
	<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"/>
	<id>1</id>
	<name>eu-west-1-updated</name>
	<uuid>DatacenterUUID</uuid>
	<remoteServices>
		<remoteService>
        	<link title="eu-west-1" rel="publiccloudregion" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
	        <link title="check" rel="check" href="http://example.com/api/admin/publiccloudregions/1/remoteservices/nodecollector/action/check"/>
    	    <link title="NODE_COLLECTOR" rel="edit" type="application/vnd.abiquo.remoteservice+xml" href="http://example.com/api/admin/publiccloudregions/1/remoteservices/nodecollector"/>
        	<id>1</id>
	        <type>NODE_COLLECTOR</type>
    	    <uri>http://example.com/nodecollector</uri>
        	<status>1</status>
	    </remoteService>
    	<remoteService>
        	<link title="eu-west-1" rel="publiccloudregion" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
	        <link title="check" rel="check" href="http://example.com/api/admin/publiccloudregions/1/remoteservices/virtualsystemmonitor/action/check"/>
    	    <link title="VIRTUAL_SYSTEM_MONITOR" rel="edit" type="application/vnd.abiquo.remoteservice+xml" href="http://example.com/api/admin/publiccloudregions/1/remoteservices/virtualsystemmonitor"/>
	        <id>2</id>
    	    <type>VIRTUAL_SYSTEM_MONITOR</type>
        	<uri>http://example.com/vsm</uri>
	        <status>1</status>
    	</remoteService>
	    <remoteService>
    	    <link title="eu-west-1" rel="publiccloudregion" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
	        <link title="check" rel="check" href="http://example.com/api/admin/publiccloudregions/1/remoteservices/virtualfactory/action/check"/>
        	<link title="VIRTUAL_FACTORY" rel="edit" type="application/vnd.abiquo.remoteservice+xml" href="http://example.com/api/admin/publiccloudregions/1/remoteservices/virtualfactory"/>
    	    <id>3</id>
        	<type>VIRTUAL_FACTORY</type>
	        <uri>http://example.com/virtualfactory</uri>
    	    <status>1</status>
	    </remoteService>
	    <remoteService>
    	    <link title="eu-west-1" rel="publiccloudregion" type="application/vnd.abiquo.publiccloudregion+xml" href="http://example.com/api/admin/publiccloudregions/1"/>
        	<link title="check" rel="check" href="http://example.com/api/admin/publiccloudregions/1/remoteservices/cloudproviderproxy/action/check"/>
	        <link title="CLOUD_PROVIDER_PROXY" rel="edit" type="application/vnd.abiquo.remoteservice+xml" href="http://example.com/api/admin/publiccloudregions/1/remoteservices/cloudproviderproxy"/>
    	    <id>4</id>
        	<type>CLOUD_PROVIDER_PROXY</type>
	        <uri>http://example.com/cpp</uri>
    	    <status>1</status>
	    </remoteService>
</publiccloudregion>

Delete a public cloud region

Remove a public cloud region. This will remove the public cloud region from Abiquo.

Synopsis: DELETE http://example.com/api/admin/publiccloudregion/{publiccloudregion}
Roles Required:  PHYS_DC_MANAGE 
Request Headers:
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_adm_pubcldregs_X.0001.txt

cURL:

curl -X DELETE http://localhost:9000/api/admin/publiccloudregions/784 \ 
	 -H 'Accept:text/json,application/json' \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

--none--

Response payload:

--none--

Retrieve a public cloud region example
curl -X DELETE http://example.com/api/admin/publiccloudregions/1 \
	 -u user:password --verbose


DELETE http://example.com/api/admin/publiccloudregion HTTP/1.1

HTTP/1.1 204 Sin Contenido

List the enterprises in a public cloud region

Returns the enterprises that have credentials for and are allowed to use a public cloud region

Synopsis: GET http://example.com/api/admin/publiccloudregions/{publiccloudregion}/enterprises 
Roles Required:  PHYS_DC_ENUMERATE 
Request Headers: Accept:  application/vnd.abiquo.enterprises+json; version=4.4; application/vnd.abiquo.enterprises+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

 

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

List the enterprises that can use a public cloud region

 Click here to show or hide the request example

GET_adm_pubcldregs_X_ents_AC_ents_j_startw_lmt_has_by_id_asc_T.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/publiccloudregions/5181/enterprises?startwith=0&limit=1&has=247&by=id&asc=true \ 
	 -H 'Accept:application/vnd.abiquo.enterprises+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/admin/publiccloudregions/5181/enterprises?limit=1&has=247&by=id&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/5181/enterprises?startwith=0&limit=1&has=247&by=id&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "ramHard": 0, 
      "isReservationRestricted": false, 
      "twoFactorAuthenticationMandatory": false, 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "edit", 
          "title": "247"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/users", 
          "type": "application/vnd.abiquo.users+json", 
          "rel": "users", 
          "title": "users"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/properties", 
          "type": "application/vnd.abiquo.enterpriseproperties+json", 
          "rel": "properties", 
          "title": "properties"
        }, 
        {
          "href": "http://localhost:9009/api/admin/scopes/5598", 
          "type": "application/vnd.abiquo.scope+json", 
          "rel": "scope", 
          "title": "0267"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/appslib/templateDefinitionLists", 
          "type": "application/vnd.abiquo.templatedefinitionlists+json", 
          "rel": "appslib/templateDefinitionLists", 
          "title": "template definitions lists"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/appslib/templateDefinitions", 
          "type": "application/vnd.abiquo.templatedefinitions+json", 
          "rel": "appslib/templateDefinitions", 
          "title": "template defintion paths"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/datacenterrepositories", 
          "type": "application/vnd.abiquo.datacenterrepositories+json", 
          "rel": "datacenterrepositories", 
          "title": "repositories"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/action/virtualmachines", 
          "type": "application/vnd.abiquo.virtualmachines+json", 
          "rel": "virtualmachines", 
          "title": "virtual machines"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/action/virtualappliances", 
          "type": "application/vnd.abiquo.virtualappliances+json", 
          "rel": "virtualappliances", 
          "title": "virtual appliances"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/action/ips", 
          "type": "application/vnd.abiquo.privateips+json", 
          "rel": "ips", 
          "title": "ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/action/virtualdatacenters", 
          "type": "application/vnd.abiquo.virtualdatacenters+json", 
          "rel": "cloud/virtualdatacenters", 
          "title": "virtual datacenters"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/reservedmachines", 
          "type": "application/vnd.abiquo.machines+json", 
          "rel": "reservedmachines", 
          "title": "reserved machines"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/limits", 
          "type": "application/vnd.abiquo.limits+json", 
          "rel": "limits", 
          "title": "limits"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/action/volumes", 
          "type": "application/vnd.abiquo.volumes+json", 
          "rel": "volumes", 
          "title": "volumes"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/action/externalnetworks", 
          "type": "application/vnd.abiquo.vlans+json", 
          "rel": "externalnetworks", 
          "title": "external networks"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/action/pendingtasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "pendingtasks", 
          "title": "pending tasks"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/credentials", 
          "type": "application/vnd.abiquo.publiccloudcredentialslist+json", 
          "rel": "credentials", 
          "title": "credentials"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5834/vappspecs", 
          "type": "application/vnd.abiquo.virtualappliancespecs+json", 
          "rel": "vappspecs", 
          "title": "virtual appliances specs"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/5181/enterprises/5834/virtualmachines", 
          "type": "application/vnd.abiquo.virtualmachines+json", 
          "rel": "virtualmachines", 
          "title": "virtual machines"
        }
      ], 
      "workflow": false, 
      "vlansHard": 0, 
      "storageHardInMb": 0, 
      "repositorySoftInMb": 0, 
      "publicIpsSoft": 0, 
      "vlansSoft": 0, 
      "ramSoft": 0, 
      "diskSoftLimitInMb": 0, 
      "id": 5834, 
      "diskHardLimitInMb": 0, 
      "name": "247", 
      "cpuHard": 0, 
      "storageSoftInMb": 0, 
      "publicIpsHard": 0, 
      "repositoryHardInMb": 0, 
      "cpuSoft": 0
    }
  ]
}

 List the enterprises that can use a public cloud region by scope

 Click here to show or hide the request example

GET_adm_pubcldregs_X_ents_AC_ents_j_idScope.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/publiccloudregions/5175/enterprises?idScope=5583 \ 
	 -H 'Accept:application/vnd.abiquo.enterprises+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/admin/publiccloudregions/5175/enterprises?idScope=5583&limit=25&by=name&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/5175/enterprises?idScope=5583&startwith=0&limit=25&by=name&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "ramHard": 0, 
      "isReservationRestricted": false, 
      "twoFactorAuthenticationMandatory": false, 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "edit", 
          "title": "90"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/users", 
          "type": "application/vnd.abiquo.users+json", 
          "rel": "users", 
          "title": "users"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/properties", 
          "type": "application/vnd.abiquo.enterpriseproperties+json", 
          "rel": "properties", 
          "title": "properties"
        }, 
        {
          "href": "http://localhost:9009/api/admin/scopes/5583", 
          "type": "application/vnd.abiquo.scope+json", 
          "rel": "scope", 
          "title": "0110"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/appslib/templateDefinitionLists", 
          "type": "application/vnd.abiquo.templatedefinitionlists+json", 
          "rel": "appslib/templateDefinitionLists", 
          "title": "template definitions lists"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/appslib/templateDefinitions", 
          "type": "application/vnd.abiquo.templatedefinitions+json", 
          "rel": "appslib/templateDefinitions", 
          "title": "template defintion paths"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/datacenterrepositories", 
          "type": "application/vnd.abiquo.datacenterrepositories+json", 
          "rel": "datacenterrepositories", 
          "title": "repositories"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/action/virtualmachines", 
          "type": "application/vnd.abiquo.virtualmachines+json", 
          "rel": "virtualmachines", 
          "title": "virtual machines"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/action/virtualappliances", 
          "type": "application/vnd.abiquo.virtualappliances+json", 
          "rel": "virtualappliances", 
          "title": "virtual appliances"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/action/ips", 
          "type": "application/vnd.abiquo.privateips+json", 
          "rel": "ips", 
          "title": "ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/action/virtualdatacenters", 
          "type": "application/vnd.abiquo.virtualdatacenters+json", 
          "rel": "cloud/virtualdatacenters", 
          "title": "virtual datacenters"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/reservedmachines", 
          "type": "application/vnd.abiquo.machines+json", 
          "rel": "reservedmachines", 
          "title": "reserved machines"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/limits", 
          "type": "application/vnd.abiquo.limits+json", 
          "rel": "limits", 
          "title": "limits"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/action/volumes", 
          "type": "application/vnd.abiquo.volumes+json", 
          "rel": "volumes", 
          "title": "volumes"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/action/externalnetworks", 
          "type": "application/vnd.abiquo.vlans+json", 
          "rel": "externalnetworks", 
          "title": "external networks"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/action/pendingtasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "pendingtasks", 
          "title": "pending tasks"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/credentials", 
          "type": "application/vnd.abiquo.publiccloudcredentialslist+json", 
          "rel": "credentials", 
          "title": "credentials"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5827/vappspecs", 
          "type": "application/vnd.abiquo.virtualappliancespecs+json", 
          "rel": "vappspecs", 
          "title": "virtual appliances specs"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/5175/enterprises/5827/virtualmachines", 
          "type": "application/vnd.abiquo.virtualmachines+json", 
          "rel": "virtualmachines", 
          "title": "virtual machines"
        }
      ], 
      "workflow": false, 
      "vlansHard": 0, 
      "storageHardInMb": 0, 
      "repositorySoftInMb": 0, 
      "publicIpsSoft": 0, 
      "vlansSoft": 0, 
      "ramSoft": 0, 
      "diskSoftLimitInMb": 0, 
      "id": 5827, 
      "diskHardLimitInMb": 0, 
      "name": "90", 
      "cpuHard": 0, 
      "storageSoftInMb": 0, 
      "publicIpsHard": 0, 
      "repositoryHardInMb": 0, 
      "cpuSoft": 0
    }
  ]
}

Get an enterprise in a public cloud region

Return an enterprises that has credentials for a public cloud region and is allowed to use it

Synopsis: GET http://example.com/api/admin/publiccloudregions/{publiccloudregion}/enterprises/{enterprise} 
Roles Required:  PHYS_DC_ENUMERATE 
Request Headers: Accept:  application/vnd.abiquo.enterprise+json; version=4.4; application/vnd.abiquo.enterprise+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

 

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

Get an enterprise that can use a public cloud region

 Click here to show or hide the request example

GET_adm_pubcldregs_X_ents_X_AC_ent_j.0001.txt

cURL:

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

Success status code: 200

Request payload:

--none--

Response payload:

{
  "ramHard": 308, 
  "isReservationRestricted": false, 
  "twoFactorAuthenticationMandatory": false, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836", 
      "type": "application/vnd.abiquo.enterprise+json", 
      "rel": "edit", 
      "title": "307"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/users", 
      "type": "application/vnd.abiquo.users+json", 
      "rel": "users", 
      "title": "users"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/properties", 
      "type": "application/vnd.abiquo.enterpriseproperties+json", 
      "rel": "properties", 
      "title": "properties"
    }, 
    {
      "href": "http://localhost:9009/api/admin/scopes/5601", 
      "type": "application/vnd.abiquo.scope+json", 
      "rel": "scope", 
      "title": "0297"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/appslib/templateDefinitionLists", 
      "type": "application/vnd.abiquo.templatedefinitionlists+json", 
      "rel": "appslib/templateDefinitionLists", 
      "title": "template definitions lists"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/appslib/templateDefinitions", 
      "type": "application/vnd.abiquo.templatedefinitions+json", 
      "rel": "appslib/templateDefinitions", 
      "title": "template defintion paths"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/datacenterrepositories", 
      "type": "application/vnd.abiquo.datacenterrepositories+json", 
      "rel": "datacenterrepositories", 
      "title": "repositories"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/action/virtualmachines", 
      "type": "application/vnd.abiquo.virtualmachines+json", 
      "rel": "virtualmachines", 
      "title": "virtual machines"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/action/virtualappliances", 
      "type": "application/vnd.abiquo.virtualappliances+json", 
      "rel": "virtualappliances", 
      "title": "virtual appliances"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/action/ips", 
      "type": "application/vnd.abiquo.privateips+json", 
      "rel": "ips", 
      "title": "ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/action/virtualdatacenters", 
      "type": "application/vnd.abiquo.virtualdatacenters+json", 
      "rel": "cloud/virtualdatacenters", 
      "title": "virtual datacenters"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/reservedmachines", 
      "type": "application/vnd.abiquo.machines+json", 
      "rel": "reservedmachines", 
      "title": "reserved machines"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/limits", 
      "type": "application/vnd.abiquo.limits+json", 
      "rel": "limits", 
      "title": "limits"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/action/volumes", 
      "type": "application/vnd.abiquo.volumes+json", 
      "rel": "volumes", 
      "title": "volumes"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/action/externalnetworks", 
      "type": "application/vnd.abiquo.vlans+json", 
      "rel": "externalnetworks", 
      "title": "external networks"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/action/pendingtasks", 
      "type": "application/vnd.abiquo.tasks+json", 
      "rel": "pendingtasks", 
      "title": "pending tasks"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/credentials", 
      "type": "application/vnd.abiquo.publiccloudcredentialslist+json", 
      "rel": "credentials", 
      "title": "credentials"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5836/vappspecs", 
      "type": "application/vnd.abiquo.virtualappliancespecs+json", 
      "rel": "vappspecs", 
      "title": "virtual appliances specs"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/5182/enterprises/5836/virtualmachines", 
      "type": "application/vnd.abiquo.virtualmachines+json", 
      "rel": "virtualmachines", 
      "title": "virtual machines"
    }
  ], 
  "workflow": false, 
  "vlansHard": 0, 
  "storageHardInMb": 0, 
  "repositorySoftInMb": 0, 
  "publicIpsSoft": 0, 
  "vlansSoft": 0, 
  "ramSoft": 308, 
  "diskSoftLimitInMb": 308, 
  "id": 5836, 
  "diskHardLimitInMb": 308, 
  "name": "307", 
  "cpuHard": 308, 
  "storageSoftInMb": 0, 
  "publicIpsHard": 0, 
  "repositoryHardInMb": 0, 
  "cpuSoft": 308
}

 Get an enterprise that can use a public cloud region by scope

 Click here to show or hide the request example

GET_adm_pubcldregs_X_ents_X_AC_ent_j_idScope.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/publiccloudregions/5172/enterprises/5824?idScope=5574 \ 
	 -H 'Accept:application/vnd.abiquo.enterprise+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "ramHard": 0, 
  "isReservationRestricted": false, 
  "twoFactorAuthenticationMandatory": false, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824", 
      "type": "application/vnd.abiquo.enterprise+json", 
      "rel": "edit", 
      "title": "0"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/users", 
      "type": "application/vnd.abiquo.users+json", 
      "rel": "users", 
      "title": "users"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/properties", 
      "type": "application/vnd.abiquo.enterpriseproperties+json", 
      "rel": "properties", 
      "title": "properties"
    }, 
    {
      "href": "http://localhost:9009/api/admin/scopes/5574", 
      "type": "application/vnd.abiquo.scope+json", 
      "rel": "scope", 
      "title": "0020"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/appslib/templateDefinitionLists", 
      "type": "application/vnd.abiquo.templatedefinitionlists+json", 
      "rel": "appslib/templateDefinitionLists", 
      "title": "template definitions lists"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/appslib/templateDefinitions", 
      "type": "application/vnd.abiquo.templatedefinitions+json", 
      "rel": "appslib/templateDefinitions", 
      "title": "template defintion paths"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/datacenterrepositories", 
      "type": "application/vnd.abiquo.datacenterrepositories+json", 
      "rel": "datacenterrepositories", 
      "title": "repositories"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/action/virtualmachines", 
      "type": "application/vnd.abiquo.virtualmachines+json", 
      "rel": "virtualmachines", 
      "title": "virtual machines"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/action/virtualappliances", 
      "type": "application/vnd.abiquo.virtualappliances+json", 
      "rel": "virtualappliances", 
      "title": "virtual appliances"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/action/ips", 
      "type": "application/vnd.abiquo.privateips+json", 
      "rel": "ips", 
      "title": "ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/action/virtualdatacenters", 
      "type": "application/vnd.abiquo.virtualdatacenters+json", 
      "rel": "cloud/virtualdatacenters", 
      "title": "virtual datacenters"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/reservedmachines", 
      "type": "application/vnd.abiquo.machines+json", 
      "rel": "reservedmachines", 
      "title": "reserved machines"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/limits", 
      "type": "application/vnd.abiquo.limits+json", 
      "rel": "limits", 
      "title": "limits"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/action/volumes", 
      "type": "application/vnd.abiquo.volumes+json", 
      "rel": "volumes", 
      "title": "volumes"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/action/externalnetworks", 
      "type": "application/vnd.abiquo.vlans+json", 
      "rel": "externalnetworks", 
      "title": "external networks"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/action/pendingtasks", 
      "type": "application/vnd.abiquo.tasks+json", 
      "rel": "pendingtasks", 
      "title": "pending tasks"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/credentials", 
      "type": "application/vnd.abiquo.publiccloudcredentialslist+json", 
      "rel": "credentials", 
      "title": "credentials"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/5824/vappspecs", 
      "type": "application/vnd.abiquo.virtualappliancespecs+json", 
      "rel": "vappspecs", 
      "title": "virtual appliances specs"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/5172/enterprises/5824/virtualmachines", 
      "type": "application/vnd.abiquo.virtualmachines+json", 
      "rel": "virtualmachines", 
      "title": "virtual machines"
    }
  ], 
  "workflow": false, 
  "vlansHard": 0, 
  "storageHardInMb": 0, 
  "repositorySoftInMb": 0, 
  "publicIpsSoft": 0, 
  "vlansSoft": 0, 
  "ramSoft": 0, 
  "diskSoftLimitInMb": 0, 
  "id": 5824, 
  "diskHardLimitInMb": 0, 
  "name": "0", 
  "cpuHard": 0, 
  "storageSoftInMb": 0, 
  "publicIpsHard": 0, 
  "repositoryHardInMb": 0, 
  "cpuSoft": 0
}



List the virtual machines of an enterprise in a public cloud region

Returns the virtual machines of the enterprises that have credentials for a public cloud region and are allowed to use it.

Synopsis: GET http://example.com/api/admin/publiccloudregions/{publiccloudregion}/enterprises/{enterprise}/virtualmachines 
Roles Required:  PHYS_DC_ENUMERATE 
Request Headers: Accept:  application/vnd.abiquo.virtualmachines+json; version=4.4; application/vnd.abiquo.virtualmachines+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

 

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

List the virtual machines of an enterprise that can use a public cloud region

 Click here to show or hide the request example

GET_adm_pubcldregs_X_ents_X_vms_AC_vms_j_startw_lmt_has_by_id_asc_T.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/publiccloudregions/5389/enterprises/6098/virtualmachines?startwith=0&limit=1&has=master&by=id&asc=true \ 
	 -H 'Accept:application/vnd.abiquo.virtualmachines+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/admin/publiccloudregions/5389/enterprises/6098/virtualmachines?limit=1&has=master&by=id&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/5389/enterprises/6098/virtualmachines?startwith=0&limit=1&has=master&by=id&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "links": [
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889", 
          "type": "application/vnd.abiquo.virtualmachine+json", 
          "rel": "edit", 
          "title": "master"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/6098", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "467"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/6098/users/6299", 
          "type": "application/vnd.abiquo.user+json", 
          "rel": "user", 
          "title": "469 470"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225", 
          "type": "application/vnd.abiquo.virtualdatacenter+json", 
          "rel": "virtualdatacenter", 
          "title": "487"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892", 
          "type": "application/vnd.abiquo.virtualappliance+json", 
          "rel": "virtualappliance", 
          "title": "493"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/metadata", 
          "type": "application/vnd.abiquo.metadata+json", 
          "rel": "metadata", 
          "title": "metadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/network/configurations", 
          "type": "application/vnd.abiquo.virtualmachinenetworkconfigurations+json", 
          "rel": "configurations", 
          "title": "vlan network configurations"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/network/nics", 
          "type": "application/vnd.abiquo.nics+json", 
          "rel": "nics", 
          "title": "nics"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/storage/disks", 
          "type": "application/vnd.abiquo.harddisks+json", 
          "rel": "harddisks", 
          "title": "disks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/state", 
          "type": "application/vnd.abiquo.virtualmachinestate+json", 
          "rel": "state", 
          "title": "OFF"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/action/undeploy", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "undeploy", 
          "title": "virtual machine undeploy"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/action/deploy", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "deploy", 
          "title": "virtual machine deploy"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/action/reset", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "reset", 
          "title": "virtual machine reset"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/action/instance", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "instance", 
          "title": "virtual machine snapshot"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/config/rdpaccess", 
          "type": "application/vnd.abiquo.virtualmachineconsole+json", 
          "rel": "rdpaccess", 
          "title": "remote access"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/firewalls", 
          "type": "application/vnd.abiquo.links+json", 
          "rel": "firewalls", 
          "title": "firewalls"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/loadbalancers", 
          "type": "application/vnd.abiquo.loadbalancers+json", 
          "rel": "loadbalancers", 
          "title": "load balancers"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/backup/action/request", 
          "type": "application/vnd.abiquo.ondemandbackup+json", 
          "rel": "requestbackup", 
          "title": "request on demand backup"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/backup/action/restore", 
          "type": "application/vnd.abiquo.restore+json", 
          "rel": "requestrestore", 
          "title": "request a restore of a backup"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/storage/volumes", 
          "type": "application/vnd.abiquo.volumes+json", 
          "rel": "volumes", 
          "title": "volumes"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/5389/hardwareprofiles/397", 
          "type": "application/vnd.abiquo.hardwareprofile+json", 
          "rel": "hardwareprofile", 
          "title": "501"
        }, 
        {
          "length": "10", 
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/disks/19920", 
          "rel": "disk0", 
          "title": "17660b72-fcf6-4463-ab19-cb28f3aa41ba", 
          "diskControllerType": "IDE", 
          "type": "application/vnd.abiquo.harddisk+json", 
          "diskLabel": "505"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/action/protect", 
          "type": "text/plain", 
          "rel": "protect", 
          "title": "protect"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/action/unprotect", 
          "type": "text/plain", 
          "rel": "unprotect", 
          "title": "unprotect"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/alarms", 
          "type": "application/vnd.abiquo.alarms+json", 
          "rel": "alarms", 
          "title": "alarms"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/actionplans", 
          "type": "application/vnd.abiquo.virtualmachineactionplans+json", 
          "rel": "actionplans", 
          "title": "actionplans"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/actionplans", 
          "type": "application/vnd.abiquo.virtualmachineactionplansflat+json", 
          "rel": "actionplansflat", 
          "title": "actionplansflat"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3225/virtualappliances/1892/virtualmachines/1889/action/clone", 
          "type": "application/vnd.abiquo.virtualmachinecloneoptions+json", 
          "rel": "clone", 
          "title": "clone"
        }, 
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST", 
          "type": "application/vnd.abiquo.hypervisortype+json", 
          "rel": "hypervisortype", 
          "title": "CloudProviderTest"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/6098/datacenterrepositories/5389/virtualmachinetemplates/2367", 
          "type": "application/vnd.abiquo.virtualmachinetemplate+json", 
          "rel": "virtualmachinetemplate", 
          "title": "497"
        }, 
        {
          "href": "http://localhost:9009/api/config/categories/2308", 
          "type": "application/vnd.abiquo.category+json", 
          "rel": "category", 
          "title": "500"
        }
      ], 
      "idType": 0, 
      "variables": {}, 
      "ram": 4, 
      "highDisponibility": 0, 
      "creationTimestamp": 1512488027000, 
      "id": 1889, 
      "uuid": "94bba857-8da4-4401-bcd7-607d7be1f602", 
      "vdrpPort": 0, 
      "backuppolicies": [], 
      "monitored": false, 
      "name": "master", 
      "idState": 6, 
      "vdrpEnabled": true, 
      "state": "OFF", 
      "protected": false, 
      "lastSynchronize": 1512488027000, 
      "type": "MANAGED", 
      "cpu": 1, 
      "generateGuestInitialPassword": false, 
      "metadata": null
    }
  ]
}

 List the virtual machines of an enterprise that can use a public cloud region by scope

 Click here to show or hide the request example

GET_adm_pubcldregs_X_ents_X_vms_AC_vms_j_idScope.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/publiccloudregions/5384/enterprises/6091/virtualmachines?idScope=5900 \ 
	 -H 'Accept:application/vnd.abiquo.virtualmachines+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/admin/publiccloudregions/5384/enterprises/6091/virtualmachines?idScope=5900&limit=25&by=name&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/5384/enterprises/6091/virtualmachines?idScope=5900&startwith=0&limit=25&by=name&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "links": [
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884", 
          "type": "application/vnd.abiquo.virtualmachine+json", 
          "rel": "edit", 
          "title": "master"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/6091", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "213"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/6091/users/6284", 
          "type": "application/vnd.abiquo.user+json", 
          "rel": "user", 
          "title": "215 216"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220", 
          "type": "application/vnd.abiquo.virtualdatacenter+json", 
          "rel": "virtualdatacenter", 
          "title": "233"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887", 
          "type": "application/vnd.abiquo.virtualappliance+json", 
          "rel": "virtualappliance", 
          "title": "239"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/metadata", 
          "type": "application/vnd.abiquo.metadata+json", 
          "rel": "metadata", 
          "title": "metadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/network/configurations", 
          "type": "application/vnd.abiquo.virtualmachinenetworkconfigurations+json", 
          "rel": "configurations", 
          "title": "vlan network configurations"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/network/nics", 
          "type": "application/vnd.abiquo.nics+json", 
          "rel": "nics", 
          "title": "nics"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/storage/disks", 
          "type": "application/vnd.abiquo.harddisks+json", 
          "rel": "harddisks", 
          "title": "disks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/state", 
          "type": "application/vnd.abiquo.virtualmachinestate+json", 
          "rel": "state", 
          "title": "OFF"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/action/undeploy", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "undeploy", 
          "title": "virtual machine undeploy"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/action/deploy", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "deploy", 
          "title": "virtual machine deploy"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/action/reset", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "reset", 
          "title": "virtual machine reset"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/action/instance", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "instance", 
          "title": "virtual machine snapshot"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/config/rdpaccess", 
          "type": "application/vnd.abiquo.virtualmachineconsole+json", 
          "rel": "rdpaccess", 
          "title": "remote access"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/firewalls", 
          "type": "application/vnd.abiquo.links+json", 
          "rel": "firewalls", 
          "title": "firewalls"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/loadbalancers", 
          "type": "application/vnd.abiquo.loadbalancers+json", 
          "rel": "loadbalancers", 
          "title": "load balancers"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/backup/action/request", 
          "type": "application/vnd.abiquo.ondemandbackup+json", 
          "rel": "requestbackup", 
          "title": "request on demand backup"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/backup/action/restore", 
          "type": "application/vnd.abiquo.restore+json", 
          "rel": "requestrestore", 
          "title": "request a restore of a backup"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/storage/volumes", 
          "type": "application/vnd.abiquo.volumes+json", 
          "rel": "volumes", 
          "title": "volumes"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/5384/hardwareprofiles/387", 
          "type": "application/vnd.abiquo.hardwareprofile+json", 
          "rel": "hardwareprofile", 
          "title": "247"
        }, 
        {
          "length": "10", 
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/disks/19915", 
          "rel": "disk0", 
          "title": "3a37189d-3374-4c5c-ae5d-0965f814dbe0", 
          "diskControllerType": "IDE", 
          "type": "application/vnd.abiquo.harddisk+json", 
          "diskLabel": "251"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/action/protect", 
          "type": "text/plain", 
          "rel": "protect", 
          "title": "protect"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/action/unprotect", 
          "type": "text/plain", 
          "rel": "unprotect", 
          "title": "unprotect"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/alarms", 
          "type": "application/vnd.abiquo.alarms+json", 
          "rel": "alarms", 
          "title": "alarms"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/actionplans", 
          "type": "application/vnd.abiquo.virtualmachineactionplans+json", 
          "rel": "actionplans", 
          "title": "actionplans"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/actionplans", 
          "type": "application/vnd.abiquo.virtualmachineactionplansflat+json", 
          "rel": "actionplansflat", 
          "title": "actionplansflat"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/3220/virtualappliances/1887/virtualmachines/1884/action/clone", 
          "type": "application/vnd.abiquo.virtualmachinecloneoptions+json", 
          "rel": "clone", 
          "title": "clone"
        }, 
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST", 
          "type": "application/vnd.abiquo.hypervisortype+json", 
          "rel": "hypervisortype", 
          "title": "CloudProviderTest"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/6091/datacenterrepositories/5384/virtualmachinetemplates/2362", 
          "type": "application/vnd.abiquo.virtualmachinetemplate+json", 
          "rel": "virtualmachinetemplate", 
          "title": "243"
        }, 
        {
          "href": "http://localhost:9009/api/config/categories/2303", 
          "type": "application/vnd.abiquo.category+json", 
          "rel": "category", 
          "title": "246"
        }
      ], 
      "idType": 0, 
      "variables": {}, 
      "ram": 4, 
      "highDisponibility": 0, 
      "creationTimestamp": 1512488026000, 
      "id": 1884, 
      "uuid": "184f00f4-9b9c-4fbc-abba-1b65dc5ea8aa", 
      "vdrpPort": 0, 
      "backuppolicies": [], 
      "monitored": false, 
      "name": "master", 
      "idState": 6, 
      "vdrpEnabled": true, 
      "state": "OFF", 
      "protected": false, 
      "lastSynchronize": 1512488026000, 
      "type": "MANAGED", 
      "cpu": 1, 
      "generateGuestInitialPassword": false, 
      "metadata": null
    }
  ]
}

Get a virtual machine of an enterprise in a public cloud region

Gets a virtual machine of an enterprise that has credentials for a public cloud region and is allowed to use it.

Synopsis: GET http://example.com/api/admin/publiccloudregions/{publiccloudregion}/enterprises/{enterprise}/virtualmachines/{virtualmachine} 
Roles Required:  PHYS_DC_ENUMERATE 
Request Headers: Accept:  application/vnd.abiquo.virtualmachine+json; version=4.4; application/vnd.abiquo.virtualmachine+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

 

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

Get a virtual machines of an enterprise that can use a public cloud region

 Click here to show or hide the request example

GET_adm_pubcldregs_X_ents_X_vms_X_AC_vm_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/publiccloudregions/5396/enterprises/6107/virtualmachines/1896 \ 
	 -H 'Accept:application/vnd.abiquo.virtualmachine+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896", 
      "type": "application/vnd.abiquo.virtualmachine+json", 
      "rel": "edit", 
      "title": "master"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/6107", 
      "type": "application/vnd.abiquo.enterprise+json", 
      "rel": "enterprise", 
      "title": "821"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/6107/users/6320", 
      "type": "application/vnd.abiquo.user+json", 
      "rel": "user", 
      "title": "823 824"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232", 
      "type": "application/vnd.abiquo.virtualdatacenter+json", 
      "rel": "virtualdatacenter", 
      "title": "841"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899", 
      "type": "application/vnd.abiquo.virtualappliance+json", 
      "rel": "virtualappliance", 
      "title": "847"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/metadata", 
      "type": "application/vnd.abiquo.metadata+json", 
      "rel": "metadata", 
      "title": "metadata"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/network/configurations", 
      "type": "application/vnd.abiquo.virtualmachinenetworkconfigurations+json", 
      "rel": "configurations", 
      "title": "vlan network configurations"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/network/nics", 
      "type": "application/vnd.abiquo.nics+json", 
      "rel": "nics", 
      "title": "nics"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/storage/disks", 
      "type": "application/vnd.abiquo.harddisks+json", 
      "rel": "harddisks", 
      "title": "disks"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/state", 
      "type": "application/vnd.abiquo.virtualmachinestate+json", 
      "rel": "state", 
      "title": "OFF"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/action/undeploy", 
      "type": "application/vnd.abiquo.acceptedrequest+json", 
      "rel": "undeploy", 
      "title": "virtual machine undeploy"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/action/deploy", 
      "type": "application/vnd.abiquo.acceptedrequest+json", 
      "rel": "deploy", 
      "title": "virtual machine deploy"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/action/reset", 
      "type": "application/vnd.abiquo.acceptedrequest+json", 
      "rel": "reset", 
      "title": "virtual machine reset"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/action/instance", 
      "type": "application/vnd.abiquo.acceptedrequest+json", 
      "rel": "instance", 
      "title": "virtual machine snapshot"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/config/rdpaccess", 
      "type": "application/vnd.abiquo.virtualmachineconsole+json", 
      "rel": "rdpaccess", 
      "title": "remote access"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/tasks", 
      "type": "application/vnd.abiquo.tasks+json", 
      "rel": "tasks", 
      "title": "tasks"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/firewalls", 
      "type": "application/vnd.abiquo.links+json", 
      "rel": "firewalls", 
      "title": "firewalls"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/loadbalancers", 
      "type": "application/vnd.abiquo.loadbalancers+json", 
      "rel": "loadbalancers", 
      "title": "load balancers"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/backup/action/request", 
      "type": "application/vnd.abiquo.ondemandbackup+json", 
      "rel": "requestbackup", 
      "title": "request on demand backup"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/backup/action/restore", 
      "type": "application/vnd.abiquo.restore+json", 
      "rel": "requestrestore", 
      "title": "request a restore of a backup"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/storage/volumes", 
      "type": "application/vnd.abiquo.volumes+json", 
      "rel": "volumes", 
      "title": "volumes"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/5396/hardwareprofiles/411", 
      "type": "application/vnd.abiquo.hardwareprofile+json", 
      "rel": "hardwareprofile", 
      "title": "855"
    }, 
    {
      "length": "10", 
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/disks/19927", 
      "rel": "disk0", 
      "title": "b8f18b6b-8509-40d4-bd2e-60b7209dd1e6", 
      "diskControllerType": "IDE", 
      "type": "application/vnd.abiquo.harddisk+json", 
      "diskLabel": "859"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/action/protect", 
      "type": "text/plain", 
      "rel": "protect", 
      "title": "protect"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/action/unprotect", 
      "type": "text/plain", 
      "rel": "unprotect", 
      "title": "unprotect"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/metrics", 
      "type": "application/vnd.abiquo.metricsmetadata+json", 
      "rel": "metricsmetadata", 
      "title": "metricsmetadata"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/metrics/collectd", 
      "type": "application/json", 
      "rel": "collectd", 
      "title": "collectd"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/alarms", 
      "type": "application/vnd.abiquo.alarms+json", 
      "rel": "alarms", 
      "title": "alarms"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/actionplans", 
      "type": "application/vnd.abiquo.virtualmachineactionplans+json", 
      "rel": "actionplans", 
      "title": "actionplans"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/actionplans", 
      "type": "application/vnd.abiquo.virtualmachineactionplansflat+json", 
      "rel": "actionplansflat", 
      "title": "actionplansflat"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3232/virtualappliances/1899/virtualmachines/1896/action/clone", 
      "type": "application/vnd.abiquo.virtualmachinecloneoptions+json", 
      "rel": "clone", 
      "title": "clone"
    }, 
    {
      "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST", 
      "type": "application/vnd.abiquo.hypervisortype+json", 
      "rel": "hypervisortype", 
      "title": "CloudProviderTest"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/6107/datacenterrepositories/5396/virtualmachinetemplates/2374", 
      "type": "application/vnd.abiquo.virtualmachinetemplate+json", 
      "rel": "virtualmachinetemplate", 
      "title": "851"
    }, 
    {
      "href": "http://localhost:9009/api/config/categories/2315", 
      "type": "application/vnd.abiquo.category+json", 
      "rel": "category", 
      "title": "854"
    }
  ], 
  "idType": 0, 
  "variables": {}, 
  "ram": 4, 
  "highDisponibility": 0, 
  "creationTimestamp": 1512488029000, 
  "id": 1896, 
  "uuid": "728f270c-7073-43e2-9f70-3a1574cf8b01", 
  "vdrpPort": 0, 
  "backuppolicies": [], 
  "monitored": false, 
  "name": "master", 
  "idState": 6, 
  "vdrpEnabled": true, 
  "state": "OFF", 
  "protected": false, 
  "lastSynchronize": 1512488029000, 
  "type": "MANAGED", 
  "cpu": 1, 
  "generateGuestInitialPassword": false, 
  "metadata": null
}

 Get a virtual machine of an enterprise that can use a public cloud region by scope

 Click here to show or hide the request example

GET_adm_pubcldregs_X_ents_X_vms_X_AC_vm_j_idScope.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/publiccloudregions/5390/enterprises/6099/virtualmachines/1890?idScope=5924 \ 
	 -H 'Accept:application/vnd.abiquo.virtualmachine+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890", 
      "type": "application/vnd.abiquo.virtualmachine+json", 
      "rel": "edit", 
      "title": "master"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/6099", 
      "type": "application/vnd.abiquo.enterprise+json", 
      "rel": "enterprise", 
      "title": "517"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/6099/users/6302", 
      "type": "application/vnd.abiquo.user+json", 
      "rel": "user", 
      "title": "519 520"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226", 
      "type": "application/vnd.abiquo.virtualdatacenter+json", 
      "rel": "virtualdatacenter", 
      "title": "537"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893", 
      "type": "application/vnd.abiquo.virtualappliance+json", 
      "rel": "virtualappliance", 
      "title": "543"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/metadata", 
      "type": "application/vnd.abiquo.metadata+json", 
      "rel": "metadata", 
      "title": "metadata"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/network/configurations", 
      "type": "application/vnd.abiquo.virtualmachinenetworkconfigurations+json", 
      "rel": "configurations", 
      "title": "vlan network configurations"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/network/nics", 
      "type": "application/vnd.abiquo.nics+json", 
      "rel": "nics", 
      "title": "nics"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/storage/disks", 
      "type": "application/vnd.abiquo.harddisks+json", 
      "rel": "harddisks", 
      "title": "disks"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/state", 
      "type": "application/vnd.abiquo.virtualmachinestate+json", 
      "rel": "state", 
      "title": "OFF"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/action/undeploy", 
      "type": "application/vnd.abiquo.acceptedrequest+json", 
      "rel": "undeploy", 
      "title": "virtual machine undeploy"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/action/deploy", 
      "type": "application/vnd.abiquo.acceptedrequest+json", 
      "rel": "deploy", 
      "title": "virtual machine deploy"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/action/reset", 
      "type": "application/vnd.abiquo.acceptedrequest+json", 
      "rel": "reset", 
      "title": "virtual machine reset"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/action/instance", 
      "type": "application/vnd.abiquo.acceptedrequest+json", 
      "rel": "instance", 
      "title": "virtual machine snapshot"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/config/rdpaccess", 
      "type": "application/vnd.abiquo.virtualmachineconsole+json", 
      "rel": "rdpaccess", 
      "title": "remote access"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/tasks", 
      "type": "application/vnd.abiquo.tasks+json", 
      "rel": "tasks", 
      "title": "tasks"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/firewalls", 
      "type": "application/vnd.abiquo.links+json", 
      "rel": "firewalls", 
      "title": "firewalls"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/loadbalancers", 
      "type": "application/vnd.abiquo.loadbalancers+json", 
      "rel": "loadbalancers", 
      "title": "load balancers"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/backup/action/request", 
      "type": "application/vnd.abiquo.ondemandbackup+json", 
      "rel": "requestbackup", 
      "title": "request on demand backup"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/backup/action/restore", 
      "type": "application/vnd.abiquo.restore+json", 
      "rel": "requestrestore", 
      "title": "request a restore of a backup"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/storage/volumes", 
      "type": "application/vnd.abiquo.volumes+json", 
      "rel": "volumes", 
      "title": "volumes"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/locations/5390/hardwareprofiles/399", 
      "type": "application/vnd.abiquo.hardwareprofile+json", 
      "rel": "hardwareprofile", 
      "title": "551"
    }, 
    {
      "length": "10", 
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/disks/19921", 
      "rel": "disk0", 
      "title": "b4fb5f69-c503-4c2a-9bdb-3c2f491b8294", 
      "diskControllerType": "IDE", 
      "type": "application/vnd.abiquo.harddisk+json", 
      "diskLabel": "555"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/action/protect", 
      "type": "text/plain", 
      "rel": "protect", 
      "title": "protect"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/action/unprotect", 
      "type": "text/plain", 
      "rel": "unprotect", 
      "title": "unprotect"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/metrics", 
      "type": "application/vnd.abiquo.metricsmetadata+json", 
      "rel": "metricsmetadata", 
      "title": "metricsmetadata"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/metrics/collectd", 
      "type": "application/json", 
      "rel": "collectd", 
      "title": "collectd"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/alarms", 
      "type": "application/vnd.abiquo.alarms+json", 
      "rel": "alarms", 
      "title": "alarms"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/actionplans", 
      "type": "application/vnd.abiquo.virtualmachineactionplans+json", 
      "rel": "actionplans", 
      "title": "actionplans"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/actionplans", 
      "type": "application/vnd.abiquo.virtualmachineactionplansflat+json", 
      "rel": "actionplansflat", 
      "title": "actionplansflat"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualdatacenters/3226/virtualappliances/1893/virtualmachines/1890/action/clone", 
      "type": "application/vnd.abiquo.virtualmachinecloneoptions+json", 
      "rel": "clone", 
      "title": "clone"
    }, 
    {
      "href": "http://localhost:9009/api/config/hypervisortypes/CP_TEST", 
      "type": "application/vnd.abiquo.hypervisortype+json", 
      "rel": "hypervisortype", 
      "title": "CloudProviderTest"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/6099/datacenterrepositories/5390/virtualmachinetemplates/2368", 
      "type": "application/vnd.abiquo.virtualmachinetemplate+json", 
      "rel": "virtualmachinetemplate", 
      "title": "547"
    }, 
    {
      "href": "http://localhost:9009/api/config/categories/2309", 
      "type": "application/vnd.abiquo.category+json", 
      "rel": "category", 
      "title": "550"
    }
  ], 
  "idType": 0, 
  "variables": {}, 
  "ram": 4, 
  "highDisponibility": 0, 
  "creationTimestamp": 1512488028000, 
  "id": 1890, 
  "uuid": "2b274a2d-770f-4e4a-ab76-efe9b09b133d", 
  "vdrpPort": 0, 
  "backuppolicies": [], 
  "monitored": false, 
  "name": "master", 
  "idState": 6, 
  "vdrpEnabled": true, 
  "state": "OFF", 
  "protected": false, 
  "lastSynchronize": 1512488028000, 
  "type": "MANAGED", 
  "cpu": 1, 
  "generateGuestInitialPassword": false, 
  "metadata": null
}