GET /api/models
List all hardware models

Examples

GET /api/models
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "info": "Virtual Machine",
      "created_at": "2022-03-29 08:21:38 UTC",
      "updated_at": "2022-03-29 08:21:38 UTC",
      "vendor_class": null,
      "hardware_model": null,
      "id": 980190962,
      "name": "KVM",
      "hosts_count": 0
    },
    {
      "info": null,
      "created_at": "2022-03-29 08:21:38 UTC",
      "updated_at": "2022-03-29 08:21:38 UTC",
      "vendor_class": "Sun-Fire-V210",
      "hardware_model": "SUN4U",
      "id": 139037058,
      "name": "SUN V210",
      "hosts_count": 0
    }
  ]
}

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
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. ‘

Maruku could not parse this XML/HTML: 
<field> 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
hardware_model string
id integer
info text
name string
vendor_class string