GET /api/compute_resources
List all compute resources.

Params

Param name Description
search
optional

filter results


Value:

Must be String

order
optional

sort results


Value:

Must be String

page
optional

paginate results


Value:

Must be String

per_page
optional

number of entries per request


Value:

Must be String


GET /api/compute_resources/:id
Show an compute resource.

Params

Param name Description
id
required

Value:

Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/compute_resources
Create a compute resource.

Params

Param name Description
compute_resource
required

Value:

Must be a Hash

compute_resource[name]
required

Value:

Must be String

compute_resource[provider]
optional

Providers include


Value:

Must be String

compute_resource[url]
optional

URL for Libvirt, oVirt, and OpenStack


Value:

Must be String

compute_resource[description]
optional

Value:

Must be String

compute_resource[user]
optional

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


Value:

Must be String

compute_resource[password]
optional

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


Value:

Must be String

compute_resource[uuid]
optional

for oVirt, VMware Datacenter


Value:

Must be String

compute_resource[region]
optional

for EC2 only


Value:

Must be String

compute_resource[tenant]
optional

for OpenStack only


Value:

Must be String

compute_resource[server]
optional

for VMware


Value:

Must be String

compute_resource[set_console_password]
optional

for Libvirt and VMware only


Value:

Must be 'true' or 'false'


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

Params

Param name Description
id
required

Value:

Must be String

compute_resource
required

Value:

Must be a Hash

compute_resource[name]
optional

Value:

Must be String

compute_resource[provider]
optional

Providers include


Value:

Must be String

compute_resource[url]
optional

URL for Libvirt, oVirt, and OpenStack


Value:

Must be String

compute_resource[description]
optional

Value:

Must be String

compute_resource[user]
optional

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


Value:

Must be String

compute_resource[password]
optional

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


Value:

Must be String

compute_resource[uuid]
optional

for oVirt, VMware Datacenter


Value:

Must be String

compute_resource[region]
optional

for EC2 only


Value:

Must be String

compute_resource[tenant]
optional

for OpenStack only


Value:

Must be String

compute_resource[server]
optional

for VMware


Value:

Must be String


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

Params

Param name Description
id
required

Value:

Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.