Compute_resources

>>>

GET /api/compute_resources
List all compute resources

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer
organization_id
optional

Scope by organizations

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
id integer
location string
location_id integer
name string
organization string
organization_id integer
type string
>>>

GET /api/compute_resources/:id
Show a compute resource

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

POST /api/compute_resources
Create a compute resource

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
compute_resource
required

Validations:

  • Hash
compute_resource[name]
required

Validations:

  • String
compute_resource[provider]
optional , nil allowed

Providers include Libvirt, Ovirt, EC2, Vmware, Openstack

Validations:

  • String
compute_resource[url]
optional , nil allowed

URL for Libvirt, oVirt and OpenStack

Validations:

  • String
compute_resource[description]
optional , nil allowed

Validations:

  • String
compute_resource[user]
optional , nil allowed

Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2.

Validations:

  • String
compute_resource[password]
optional , nil allowed

Password for oVirt, EC2, VMware, OpenStack. Secret key for EC2

Validations:

  • String
compute_resource[datacenter]
optional , nil allowed

for oVirt, VMware Datacenter

Validations:

  • String
compute_resource[ovirt_quota]
optional , nil allowed

for oVirt only, ID or Name of quota to use

Validations:

  • String
compute_resource[public_key]
optional , nil allowed

for oVirt only

Validations:

  • String
compute_resource[region]
optional , nil allowed

for AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region

Validations:

  • String
compute_resource[tenant]
optional , nil allowed

for OpenStack and AzureRm only

Validations:

  • String
compute_resource[domain]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • String
compute_resource[project_domain_name]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • String
compute_resource[project_domain_id]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • String
compute_resource[server]
optional , nil allowed

for VMware

Validations:

  • String
compute_resource[set_console_password]
optional , nil allowed

for Libvirt and VMware only

Validations:

  • Must be one of: true, false, 1, 0.
compute_resource[display_type]
optional , nil allowed

for Libvirt and oVirt only

Validations:

  • Must be one of: VNC, SPICE.
compute_resource[keyboard_layout]
optional , nil allowed

for oVirt only

Validations:

  • Must be one of: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr.
compute_resource[caching_enabled]
optional , nil allowed

enable caching, for VMware only

Validations:

  • Must be one of: true, false, 1, 0.
compute_resource[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
compute_resource[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

PUT /api/compute_resources/:id
Update a compute resource

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
compute_resource
required

Validations:

  • Hash
compute_resource[name]
optional

Validations:

  • String
compute_resource[provider]
optional , nil allowed

Providers include Libvirt, Ovirt, EC2, Vmware, Openstack

Validations:

  • String
compute_resource[url]
optional , nil allowed

URL for Libvirt, oVirt and OpenStack

Validations:

  • String
compute_resource[description]
optional , nil allowed

Validations:

  • String
compute_resource[user]
optional , nil allowed

Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2.

Validations:

  • String
compute_resource[password]
optional , nil allowed

Password for oVirt, EC2, VMware, OpenStack. Secret key for EC2

Validations:

  • String
compute_resource[datacenter]
optional , nil allowed

for oVirt, VMware Datacenter

Validations:

  • String
compute_resource[ovirt_quota]
optional , nil allowed

for oVirt only, ID or Name of quota to use

Validations:

  • String
compute_resource[public_key]
optional , nil allowed

for oVirt only

Validations:

  • String
compute_resource[region]
optional , nil allowed

for AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region

Validations:

  • String
compute_resource[tenant]
optional , nil allowed

for OpenStack and AzureRm only

Validations:

  • String
compute_resource[domain]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • String
compute_resource[project_domain_name]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • String
compute_resource[project_domain_id]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • String
compute_resource[server]
optional , nil allowed

for VMware

Validations:

  • String
compute_resource[set_console_password]
optional , nil allowed

for Libvirt and VMware only

Validations:

  • Must be one of: true, false, 1, 0.
compute_resource[display_type]
optional , nil allowed

for Libvirt and oVirt only

Validations:

  • Must be one of: VNC, SPICE.
compute_resource[keyboard_layout]
optional , nil allowed

for oVirt only

Validations:

  • Must be one of: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr.
compute_resource[caching_enabled]
optional , nil allowed

enable caching, for VMware only

Validations:

  • Must be one of: true, false, 1, 0.
compute_resource[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
compute_resource[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

DELETE /api/compute_resources/:id
Delete a compute resource

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /api/compute_resources/:id/available_images
List available images for a compute resource

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /api/compute_resources/:id/available_clusters
List available clusters for a compute resource

Examples

GET /api/compute_resources/305613588-Vmware/available_clusters
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "test_vmware_object",
      "id": "my11-test35-uuid99"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /api/compute_resources/:id/available_flavors
List available flavors for a compute resource

Examples

GET /api/compute_resources/928692541-amazon123/available_flavors
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "test_ec2_object",
      "id": "123"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /api/compute_resources/:id/available_folders
List available folders for a compute resource

Examples

GET /api/compute_resources/305613588-Vmware/available_folders
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "test_vmware_object",
      "id": "my11-test35-uuid99"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /api/compute_resources/:id/available_zones
List available zone for a compute resource

Examples

GET /api/compute_resources/928692541-amazon123/available_zones
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "test_ec2_object"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /api/compute_resources/:id/available_networks
List available networks for a compute resource

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_networks
List available networks for a compute resource cluster

Examples

GET /api/compute_resources/305613588-Vmware/available_clusters/123-456-789/available_networks
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "test_vmware_object",
      "id": "my11-test35-uuid99"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
cluster_id
optional

Validations:

  • String
>>>

GET /api/compute_resources/:id/available_vnic_profiles
List available vnic profiles for a compute resource, for oVirt only

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools
List resource pools for a compute resource cluster

Examples

GET /api/compute_resources/305613588-Vmware/available_clusters/123-456-789/available_resource_pools
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "test_vmware_object",
      "id": "my11-test35-uuid99"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
cluster_id
required

Validations:

  • String
>>>

GET /api/compute_resources/:id/storage_domains/:storage_domain_id
List attributes for a given storage domain

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
storage_domain_id
required

Validations:

  • String
>>>

GET /api/compute_resources/:id/available_storage_domains
List storage domains for a compute resource

GET /api/compute_resources/:id/available_storage_domains/:storage_domain
List attributes for a given storage domain

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains
List storage domains for a compute resource

Examples

GET /api/compute_resources/305613588-Vmware/available_storage_domains
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "test_vmware_object",
      "id": "my11-test35-uuid99"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
cluster_id
optional

Validations:

  • String
storage_domain
optional

Validations:

  • String
>>>

GET /api/compute_resources/:id/storage_pods/:storage_pod_id
List attributes for a given storage pod

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
storage_pod_id
required

Validations:

  • String
>>>

GET /api/compute_resources/:id/available_storage_pods
List storage pods for a compute resource

GET /api/compute_resources/:id/available_storage_pods/:storage_pod
List attributes for a given storage pod

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods
List storage pods for a compute resource

Examples

GET /api/compute_resources/305613588-Vmware/available_storage_pods
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "test_vmware_object",
      "id": "my11-test35-uuid99"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
cluster_id
optional

Validations:

  • String
storage_pod
optional

Validations:

  • String
>>>

GET /api/compute_resources/:id/available_security_groups
List available security groups for a compute resource

Examples

GET /api/compute_resources/928692541-amazon123/available_security_groups
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "test_ec2_object",
      "group_id": "123"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

PUT /api/compute_resources/:id/associate/:vm_id
Associate VMs to Hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
vm_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

PUT /api/compute_resources/:id/refresh_cache
Refresh Compute Resource Cache

Examples

PUT /api/compute_resources/305613588-Vmware/refresh_cache
{
  "compute_resource": {}
}
200
{
  "message": "Successfully refreshed the cache."
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /api/compute_resources/:id/available_virtual_machines
List available virtual machines for a compute resource

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /api/compute_resources/:id/available_virtual_machines/:vm_id
Show a virtual machine

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
vm_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

PUT /api/compute_resources/:id/available_virtual_machines/:vm_id/power
Power a Virtual Machine

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
vm_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

DELETE /api/compute_resources/:id/available_virtual_machines/:vm_id
Delete a Virtual Machine

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
vm_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..