Models

>>>

GET /api/models
List all hardware models

Examples

GET /api/models
400
{
  "error": {
    "message": "Field 'notarightterm' not recognized for searching!",
    "class": "ScopedSearch::QueryNotSupported"
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

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

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

Examples

GET /api/models/980190962abcdef
200
{
  "info": null,
  "created_at": "2024-02-22 16:01:31 UTC",
  "updated_at": "2024-02-22 16:01:31 UTC",
  "vendor_class": null,
  "hardware_model": null,
  "id": 980190964,
  "name": "980190962abcdef",
  "hosts_count": 0
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

POST /api/models
Create a hardware model

Examples

POST /api/models
{
  "model": {
    "name": "new model"
  }
}
201
{
  "info": null,
  "created_at": "2024-02-22 16:01:31 UTC",
  "updated_at": "2024-02-22 16:01:31 UTC",
  "vendor_class": null,
  "hardware_model": null,
  "id": 980190963,
  "name": "new model",
  "hosts_count": 0
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
model
required

Validations:

  • Hash
model[name]
required

Validations:

  • String
model[info]
optional , nil allowed

Validations:

  • String
model[vendor_class]
optional , nil allowed

Validations:

  • String
model[hardware_model]
optional , nil allowed

Validations:

  • String
>>>

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

Examples

PUT /api/models/980190962-KVM
{
  "name": "KVM",
  "model": {
    "name": "KVM"
  }
}
200
{
  "info": "Virtual Machine",
  "created_at": "2024-02-22 16:01:23 UTC",
  "updated_at": "2024-02-22 16:01:23 UTC",
  "vendor_class": null,
  "hardware_model": null,
  "id": 980190962,
  "name": "KVM",
  "hosts_count": 0
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
model
required

Validations:

  • Hash
model[name]
optional

Validations:

  • String
model[info]
optional , nil allowed

Validations:

  • String
model[vendor_class]
optional , nil allowed

Validations:

  • String
model[hardware_model]
optional , nil allowed

Validations:

  • String
>>>

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

Examples

DELETE /api/models/980190962-KVM
{
  "model": {}
}
200
{
  "id": 980190962,
  "name": "KVM",
  "info": "Virtual Machine",
  "created_at": "2024-02-22T16:01:23.114Z",
  "updated_at": "2024-02-22T16:01:23.114Z",
  "vendor_class": null,
  "hardware_model": null
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String