These API calls are related to nested parameters for a host, domain, subnet, host group, operating system. If you are looking for global parameters, go to this link.


GET /api/hosts/:host_id/parameters
Listar todos los parámetros de un host

GET /api/hostgroups/:hostgroup_id/parameters
Listar todos los parámetros de un grupo de hosts

GET /api/domains/:domain_id/parameters
Listar todos los parámetros de un dominio

GET /api/operatingsystems/:operatingsystem_id/parameters
Listar todos los parámetros de un sistema operativo

GET /api/locations/:location_id/parameters
Listar todos los parámetros de una ubicación

GET /api/organizations/:organization_id/parameters
Listar todos los parámetros de una organización

GET /api/subnets/:subnet_id/parameters
Enumerar todos los parámetros para una subred

Ejemplos

GET /api/hosts/host2324/parameters
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "priority": 70,
      "created_at": "2019-09-11 14:55:09 UTC",
      "updated_at": "2019-09-11 14:55:09 UTC",
      "id": 767575239,
      "name": "parameter332",
      "parameter_type": null,
      "value": "parameter value 359"
    }
  ]
}

Parámetros

Nombre del parámetro Descripción
host_id
opcional

ID del host

Validations:

  • Must be a String

hostgroup_id
opcional

ID del grupo de hosts

Validations:

  • Must be a String

domain_id
opcional

ID del dominio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID del sistema operativo

Validations:

  • Must be a String

location_id
opcional

ID de la ubicación

Validations:

  • Must be a String

organization_id
opcional

ID de la organización

Validations:

  • Must be a String

subnet_id
opcional

ID de la subred

Validations:

  • Must be a String

show_hidden
opcional

Mostrar valores ocultos

Validations:

  • Must be one of: true, false, 1, 0.

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
domain_name string
host_group_name string
host_name string
key_type string
location_name string
name string
organization_name string
os_name string
parameter_type string
subnet_name text
type string
value text

GET /api/hosts/:host_id/parameters/:id
Mostrar un parámetro anidado para un host

GET /api/hostgroups/:hostgroup_id/parameters/:id
Mostrar un parámetro anidado para un grupo de hosts

GET /api/domains/:domain_id/parameters/:id
Mostrar un parámetro anidado para un dominio

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Mostrar un parámetro anidado para un sistema operativo

GET /api/locations/:location_id/parameters/:id
Mostrar un parámetro anidado para una ubicación

GET /api/organizations/:organization_id/parameters/:id
Mostrar un parámetro anidado para una organización

GET /api/subnets/:subnet_id/parameters/:id
Mostrar un parámetro anidado para una subred

Ejemplos

GET /api/hosts/host470/parameters/767575240-parameter10
200
{
  "priority": 70,
  "created_at": "2019-09-11 14:35:47 UTC",
  "updated_at": "2019-09-11 14:35:47 UTC",
  "id": 767575240,
  "name": "parameter10",
  "parameter_type": null,
  "value": "parameter value 10"
}

Parámetros

Nombre del parámetro Descripción
host_id
opcional

ID del host

Validations:

  • Must be a String

hostgroup_id
opcional

ID del grupo de hosts

Validations:

  • Must be a String

domain_id
opcional

ID del dominio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID del sistema operativo

Validations:

  • Must be a String

location_id
opcional

ID de la ubicación

Validations:

  • Must be a String

organization_id
opcional

ID de la organización

Validations:

  • Must be a String

subnet_id
opcional

ID de la subred

Validations:

  • Must be a String

id
requerido

ID del parámetro

Validations:

  • Must be a String

show_hidden
opcional

Mostrar valores ocultos

Validations:

  • Must be one of: true, false, 1, 0.


POST /api/hosts/:host_id/parameters
Crear un parámetro anidado para un host

POST /api/hostgroups/:hostgroup_id/parameters
Crear un parámetro anidado para un grupo de hosts

POST /api/domains/:domain_id/parameters
Crear un parámetro anidado para un dominio

POST /api/operatingsystems/:operatingsystem_id/parameters
Crear un parámetro anidado para un sistema operativo

POST /api/locations/:location_id/parameters
Crear un parámetro anidado para una ubicación

POST /api/organizations/:organization_id/parameters
Crear un parámetro anidado para una organización

POST /api/subnets/:subnet_id/parameters
Crear un parámetro anidado para una subred

Ejemplos

POST /api/domains/22495316-mydomain-net/parameters
{
  "parameter": {
    "name": "parameter2",
    "value": "X"
  }
}
201
{
  "priority": 30,
  "created_at": "2019-09-11 14:57:35 UTC",
  "updated_at": "2019-09-11 14:57:35 UTC",
  "id": 767575246,
  "name": "parameter2",
  "parameter_type": null,
  "value": "X"
}

Parámetros

Nombre del parámetro Descripción
host_id
opcional

ID del host

Validations:

  • Must be a String

hostgroup_id
opcional

ID del grupo de hosts

Validations:

  • Must be a String

domain_id
opcional

ID del dominio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID del sistema operativo

Validations:

  • Must be a String

location_id
opcional

ID de la ubicación

Validations:

  • Must be a String

organization_id
opcional

ID de la organización

Validations:

  • Must be a String

subnet_id
opcional

ID de la subred

Validations:

  • Must be a String

parameter
requerido

Validations:

  • Must be a Hash

parameter[name]
requerido

Validations:

  • Must be a String

parameter[value]
requerido

Validations:

  • Must be a String

parameter[parameter_type]
requerido

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.


PUT /api/hosts/:host_id/parameters/:id
Actualizar un parámetro anidado para un host

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Actualizar un parámetro anidado para un grupo de hosts

PUT /api/domains/:domain_id/parameters/:id
Actualizar un parámetro anidado para un dominio

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Actualizar un parámetro anidado para un sistema operativo

PUT /api/locations/:location_id/parameters/:id
Actualizar un parámetro anidado para una ubicación

PUT /api/organizations/:organization_id/parameters/:id
Actualizar un parámetro anidado para una organización

PUT /api/subnets/:subnet_id/parameters/:id
Actualizar un parámetro anidado para una subred

Ejemplos

PUT /api/domains/22495316-mydomain-net/parameters/665394701-parameter
{
  "parameter": {
    "name": "special_key",
    "value": "123"
  }
}
200
{
  "priority": null,
  "created_at": "2019-09-11 14:58:27 UTC",
  "updated_at": "2019-09-11 14:58:41 UTC",
  "id": 665394701,
  "name": "special_key",
  "parameter_type": null,
  "value": "123"
}

Parámetros

Nombre del parámetro Descripción
host_id
opcional

ID del host

Validations:

  • Must be a String

hostgroup_id
opcional

ID del grupo de hosts

Validations:

  • Must be a String

domain_id
opcional

ID del dominio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID del sistema operativo

Validations:

  • Must be a String

location_id
opcional

ID de la ubicación

Validations:

  • Must be a String

organization_id
opcional

ID de la organización

Validations:

  • Must be a String

id
requerido

ID del parámetro

Validations:

  • Must be a String

subnet_id
opcional

ID de la subred

Validations:

  • Must be a String

parameter
requerido

Validations:

  • Must be a Hash

parameter[name]
opcional

Validations:

  • Must be a String

parameter[value]
opcional

Validations:

  • Must be a String

parameter[parameter_type]
opcional

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.


DELETE /api/hosts/:host_id/parameters/:id
Borrar un parámetro anidado para un host

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Borrar un parámetro anidado para un grupo de hosts

DELETE /api/domains/:domain_id/parameters/:id
Borrar un parámetro anidado para un dominio

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Borrar un parámetro anidado para un sistema operativo

DELETE /api/locations/:location_id/parameters/:id
Borrar un parámetro anidado para una ubicación

DELETE /api/organizations/:organization_id/parameters/:id
Borrar un parámetro anidado para una organización

DELETE /api/subnets/:subnet_id/parameters/:id
Eliminar un parámetro anidado para una subred

Ejemplos

DELETE /api/subnets/1018350795-five/parameters/297943576-parameter
{
  "parameter": {}
}
200
{
  "id": 297943576,
  "name": "parameter",
  "value": "subnet1",
  "reference_id": 1018350795,
  "created_at": "2019-09-11T14:58:27.166Z",
  "updated_at": "2019-09-11T14:58:27.166Z",
  "priority": null,
  "hidden_value": "*****",
  "key_type": null
}

Parámetros

Nombre del parámetro Descripción
host_id
opcional

ID del host

Validations:

  • Must be a String

hostgroup_id
opcional

ID del grupo de hosts

Validations:

  • Must be a String

domain_id
opcional

ID del dominio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID del sistema operativo

Validations:

  • Must be a String

location_id
opcional

ID de la ubicación

Validations:

  • Must be a String

organization_id
opcional

ID de la organización

Validations:

  • Must be a String

id
requerido

ID del parámetro

Validations:

  • Must be a String

subnet_id
opcional

ID de la subred

Validations:

  • Must be a String


DELETE /api/hosts/:host_id/parameters
Borrar todos los parámetros anidados para un host

DELETE /api/hostgroups/:hostgroup_id/parameters
Borrar todos los parámetros anidados para un grupo de hosts

DELETE /api/domains/:domain_id/parameters
Borrar todos los parámetros anidados para un dominio

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Borrar todos los parámetros anidados para un sistema operativo

DELETE /api/locations/:location_id/parameters
Borrar todos los parámetros anidados para una ubicación

DELETE /api/organizations/:organization_id/parameters
Borrar todos los parámetros anidados para una organización

DELETE /api/subnets/:subnet_id/parameters
Eliminar todos los parámetros anidados para una subred

Ejemplos

DELETE /api/operatingsystems/1073012828/parameters
{
  "parameter": {}
}
200
[

]

Parámetros

Nombre del parámetro Descripción
host_id
opcional

ID del host

Validations:

  • Must be a String

hostgroup_id
opcional

ID del grupo de hosts

Validations:

  • Must be a String

domain_id
opcional

ID del dominio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID del sistema operativo

Validations:

  • Must be a String

location_id
opcional

ID de la ubicación

Validations:

  • Must be a String

organization_id
opcional

ID de la organización

Validations:

  • Must be a String

subnet_id
opcional

ID de la subred

Validations:

  • Must be a String