GET /api/compute_resources
List all compute resources

Examples

GET /api/compute_resources
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "description": "mycompute",
      "url": "test:///default",
      "created_at": "2020-11-04 15:05:54 UTC",
      "updated_at": "2020-11-04 15:05:54 UTC",
      "id": 367690737,
      "name": "mycompute",
      "provider": "Libvirt",
      "provider_friendly_name": "Libvirt",
      "display_type": "vnc",
      "set_console_password": true
    }
  ]
}

Params

Param name	Description
location_id optional	Scope by locations Validations: Must be a Integer
organization_id optional	Scope by organizations Validations: Must be a Integer
search optional	filter results Validations: Must be a String
order optional	Sort field and order, eg. ‘id DESC’ Validations: Must be a 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