Models

>>>

GET /api/models
List all hardware models

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

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
hardware_model string
info text
name string
vendor_class string
>>>

GET /api/models/:id
Show a hardware model

Examples

GET /api/models/980190962abcdef
200
{
  "info": null,
  "created_at": "2019-11-07 08:39:33 UTC",
  "updated_at": "2019-11-07 08:39:33 UTC",
  "vendor_class": null,
  "hardware_model": null,
  "id": 980190963,
  "name": "980190962abcdef",
  "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
id
required

Validations:

  • 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/models
Create a hardware model

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
model
required

Validations:

  • Must be a Hash
model[name]
required

Validations:

  • Must be a String
model[info]
optional , nil allowed

Validations:

  • Must be a String
model[vendor_class]
optional , nil allowed

Validations:

  • Must be a String
model[hardware_model]
optional , nil allowed

Validations:

  • Must be a String
>>>

PUT /api/models/:id
Update a hardware model

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
id
required

Validations:

  • Must be a String
model
required

Validations:

  • Must be a Hash
model[name]
optional

Validations:

  • Must be a String
model[info]
optional , nil allowed

Validations:

  • Must be a String
model[vendor_class]
optional , nil allowed

Validations:

  • Must be a String
model[hardware_model]
optional , nil allowed

Validations:

  • Must be a String
>>>

DELETE /api/models/:id
Delete a hardware model

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
id
required

Validations:

  • Must be a String