GET /api/models
Listar todos los modelos de hardware

Ejemplos

GET /api/models?include_permissions=true
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "can_create": true,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "info": "Virtual Machine",
      "created_at": "2019-11-07 03:37:19 -0500",
      "updated_at": "2019-11-07 03:37:19 -0500",
      "vendor_class": null,
      "hardware_model": null,
      "id": 980190962,
      "name": "KVM",
      "can_edit": true,
      "can_delete": true,
      "hosts_count": 0
    },
    {
      "info": null,
      "created_at": "2019-11-07 03:37:19 -0500",
      "updated_at": "2019-11-07 03:37:19 -0500",
      "vendor_class": "Sun-Fire-V210",
      "hardware_model": "SUN4U",
      "id": 139037058,
      "name": "SUN V210",
      "can_edit": true,
      "can_delete": true,
      "hosts_count": 0
    }
  ]
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

Campos de búsqueda

Nombre del campo Tipo Valores posibles
hardware_model string
info text
name string
vendor_class string

GET /api/models/:id
Mostrar un modelo de hardware

Ejemplos

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
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

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
Crear un modelo de hardware

Ejemplos

POST /api/models
{
  "model": {
    "name": "new model"
  }
}
201
{
  "info": null,
  "created_at": "2019-11-07 08:39:34 UTC",
  "updated_at": "2019-11-07 08:39:34 UTC",
  "vendor_class": null,
  "hardware_model": null,
  "id": 980190964,
  "name": "new model",
  "hosts_count": 0
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

model
requerido

Validations:

  • Must be a Hash

model[name]
requerido

Validations:

  • Must be a String

model[info]
opcional , nil permitido

Validations:

  • Must be a String

model[vendor_class]
opcional , nil permitido

Validations:

  • Must be a String

model[hardware_model]
opcional , nil permitido

Validations:

  • Must be a String


PUT /api/models/:id
Actualizar un modelo de hardware

Ejemplos

PUT /api/models/980190962-KVM
{
  "name": "KVM",
  "model": {
    "name": "KVM"
  }
}
200
{
  "info": "Virtual Machine",
  "created_at": "2019-11-07 08:39:32 UTC",
  "updated_at": "2019-11-07 08:39:32 UTC",
  "vendor_class": null,
  "hardware_model": null,
  "id": 980190962,
  "name": "KVM",
  "hosts_count": 0
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be a String

model
requerido

Validations:

  • Must be a Hash

model[name]
opcional

Validations:

  • Must be a String

model[info]
opcional , nil permitido

Validations:

  • Must be a String

model[vendor_class]
opcional , nil permitido

Validations:

  • Must be a String

model[hardware_model]
opcional , nil permitido

Validations:

  • Must be a String


DELETE /api/models/:id
Borrar un modelo de hardware

Ejemplos

DELETE /api/models/980190962-KVM
{
  "model": {}
}
200
{
  "id": 980190962,
  "name": "KVM",
  "info": "Virtual Machine",
  "created_at": "2019-11-07T08:39:32.062Z",
  "updated_at": "2019-11-07T08:39:32.062Z",
  "vendor_class": null,
  "hardware_model": null
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be a String