POST /api/compute_resources
Create a compute resource

Examples

POST /api/compute_resources
{
  "compute_resource": {
    "name": "",
    "provider": "libvirt",
    "organization_ids": [
      114267492
    ],
    "location_ids": [
      255093256
    ],
    "url": "qemu+ssh://root@libvirt.example.com/system"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
compute_resource
required

Validations:

  • Must be a Hash
compute_resource[name]
required

Validations:

  • Must be a String
compute_resource[provider]
optional , nil allowed

Providers include Libvirt, Ovirt, EC2, Vmware, Openstack

Validations:

  • Must be a String
compute_resource[url]
optional , nil allowed

URL for Libvirt, oVirt and OpenStack

Validations:

  • Must be a String
compute_resource[description]
optional , nil allowed

Validations:

  • Must be a String
compute_resource[user]
optional , nil allowed

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

Validations:

  • Must be a String
compute_resource[password]
optional , nil allowed

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

Validations:

  • Must be a String
compute_resource[datacenter]
optional , nil allowed

for oVirt, VMware Datacenter

Validations:

  • Must be a String
compute_resource[ovirt_quota]
optional , nil allowed

for oVirt only, ID or Name of quota to use

Validations:

  • Must be a String
compute_resource[public_key]
optional , nil allowed

for oVirt only

Validations:

  • Must be a 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:

  • Must be a String
compute_resource[tenant]
optional , nil allowed

for OpenStack and AzureRm only

Validations:

  • Must be a String
compute_resource[domain]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • Must be a String
compute_resource[project_domain_name]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • Must be a String
compute_resource[project_domain_id]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • Must be a String
compute_resource[server]
optional , nil allowed

for VMware

Validations:

  • Must be a 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