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
Lista de todos os parâmentros para um host

GET /api/hostgroups/:hostgroup_id/parameters
Lista de todos os parâmetros para um grupo host

GET /api/domains/:domain_id/parameters
Lista de todos os parâmetros para um domínio

GET /api/operatingsystems/:operatingsystem_id/parameters
Lista de todos os parâmetros para um sistema operacional

GET /api/locations/:location_id/parameters
Lista de todos os parâmetros para uma localização

GET /api/organizations/:organization_id/parameters
Lista de todos os parâmetros para uma organização

GET /api/subnets/:subnet_id/parameters
Listar todos os parâmentros para uma sub-rede

Exemplos

GET /api/domains/22495316-mydomain-net/parameters
200
{
  "total": 2,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "name = parameter2",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "priority": 30,
      "created_at": "2019-11-07 08:37:11 UTC",
      "updated_at": "2019-11-07 08:37:11 UTC",
      "id": 767575490,
      "name": "parameter2",
      "parameter_type": "string",
      "value": "X"
    }
  ]
}

Parâmentros

Nome parâmetro Descrição
host_id
opcional

ID do host

Validations:

  • Must be a String

hostgroup_id
opcional

ID do grupo de host

Validations:

  • Must be a String

domain_id
opcional

ID para um domínio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID do sistema operacional

Validations:

  • Must be a String

location_id
opcional

ID de localização

Validations:

  • Must be a String

organization_id
opcional

ID de organização

Validations:

  • Must be a String

subnet_id
opcional

ID da subrede

Validations:

  • Must be a String

show_hidden
opcional

Exibir valores ocultos

Validations:

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

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Classificar campo e ordem, ex.: ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, iniciando em 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • Must be a number.

Pesquisar campos

Nome do campo Tipo Valores possíveis
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 um parâmetro nested para um host

GET /api/hostgroups/:hostgroup_id/parameters/:id
Mostrar um parâmetro nested para um grupo de hosts

GET /api/domains/:domain_id/parameters/:id
Mostrar a paramentrô nested para um dominío

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Mostrar um parametrô para um sistema operacional

GET /api/locations/:location_id/parameters/:id
Mostrar um parametrô para uma localizão

GET /api/organizations/:organization_id/parameters/:id
Mostrar um parametrô para uma organização

GET /api/subnets/:subnet_id/parameters/:id
Mostrar um parâmetro herdado para uma sub rede

Exemplos

GET /api/hosts/host343/parameters/767575241-parameter7
200
{
  "priority": 70,
  "created_at": "2019-11-07 08:37:01 UTC",
  "updated_at": "2019-11-07 08:37:01 UTC",
  "id": 767575241,
  "name": "parameter7",
  "parameter_type": "string",
  "value": "parameter value 21"
}

Parâmentros

Nome parâmetro Descrição
host_id
opcional

ID do host

Validations:

  • Must be a String

hostgroup_id
opcional

ID do grupo de host

Validations:

  • Must be a String

domain_id
opcional

ID para um domínio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID do sistema operacional

Validations:

  • Must be a String

location_id
opcional

ID de localização

Validations:

  • Must be a String

organization_id
opcional

ID de organização

Validations:

  • Must be a String

subnet_id
opcional

ID da subrede

Validations:

  • Must be a String

id
requerido

ID do parametrô

Validations:

  • Must be a String

show_hidden
opcional

Exibir valores ocultos

Validations:

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


POST /api/hosts/:host_id/parameters
Criar um parâmetro aninhado para um host

POST /api/hostgroups/:hostgroup_id/parameters
Criar um parâmetro aninhado para um grupo de host

POST /api/domains/:domain_id/parameters
Criar um parâmetro aninhado para um domínio

POST /api/operatingsystems/:operatingsystem_id/parameters
Criar um parâmetro aninhado para um sistema operacional

POST /api/locations/:location_id/parameters
Criar um parâmetro aninhado para uma localização

POST /api/organizations/:organization_id/parameters
Criar um parâmetro aninhado para uma organização

POST /api/subnets/:subnet_id/parameters
Criar um parâmetro herdado para uma sub-rede

Exemplos

POST /api/domains/22495316-mydomain-net/parameters
{
  "parameter": {
    "name": "parameter2",
    "value": "X"
  }
}
201
{
  "priority": 30,
  "created_at": "2019-11-07 08:37:11 UTC",
  "updated_at": "2019-11-07 08:37:11 UTC",
  "id": 767575490,
  "name": "parameter2",
  "parameter_type": "string",
  "value": "X"
}

Parâmentros

Nome parâmetro Descrição
host_id
opcional

ID do host

Validations:

  • Must be a String

hostgroup_id
opcional

ID do grupo de host

Validations:

  • Must be a String

domain_id
opcional

ID para um domínio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID do sistema operacional

Validations:

  • Must be a String

location_id
opcional

ID de localização

Validations:

  • Must be a String

organization_id
opcional

ID de organização

Validations:

  • Must be a String

subnet_id
opcional

ID da subrede

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
Atualizar um paramentrô nested para um host

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Atualizar um parametrô nested para um grupo host

PUT /api/domains/:domain_id/parameters/:id
Atualizar um parametrô nested para um domínio

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Atualizar um parametrô nested para um sistema operacional

PUT /api/locations/:location_id/parameters/:id
Atualizar um parametrô nested para uma localização

PUT /api/organizations/:organization_id/parameters/:id
Atualizar um parametrô nested para uma organização

PUT /api/subnets/:subnet_id/parameters/:id
Atualizar um parametro herdado para uma sub-rede

Exemplos

PUT /api/subnets/1018350795-five/parameters/297943576-parameter
{
  "parameter": {
    "name": "special_key",
    "value": "123"
  }
}
200
{
  "priority": null,
  "created_at": "2019-11-07 09:09:56 UTC",
  "updated_at": "2019-11-07 09:09:59 UTC",
  "id": 297943576,
  "name": "special_key",
  "parameter_type": "string",
  "value": "123"
}

Parâmentros

Nome parâmetro Descrição
host_id
opcional

ID do host

Validations:

  • Must be a String

hostgroup_id
opcional

ID do grupo de host

Validations:

  • Must be a String

domain_id
opcional

ID para um domínio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID do sistema operacional

Validations:

  • Must be a String

location_id
opcional

ID de localização

Validations:

  • Must be a String

organization_id
opcional

ID de organização

Validations:

  • Must be a String

id
requerido

ID do parametrô

Validations:

  • Must be a String

subnet_id
opcional

ID da subrede

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
Apagar um parâmetro aninhado para um host

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Apagar um parâmetro aninhado para um grupo de host

DELETE /api/domains/:domain_id/parameters/:id
Apagar um parâmetro aninhado para um domínio

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Apagar um parâmetro aninhado para um sistema operacional

DELETE /api/locations/:location_id/parameters/:id
Apagar um parâmetro aninhado para uma localização

DELETE /api/organizations/:organization_id/parameters/:id
Apagar um parâmetro aninhado para uma organização

DELETE /api/subnets/:subnet_id/parameters/:id
Apagar um parâmetro aninhado para uma sub-rede

Exemplos

DELETE /api/hostgroups/636252244-Common/parameters/767575238-group1
{
  "parameter": {}
}
200
{
  "id": 767575238,
  "name": "group1",
  "value": "group1",
  "reference_id": 636252244,
  "created_at": "2019-11-07T09:09:56.749Z",
  "updated_at": "2019-11-07T09:09:56.749Z",
  "priority": null,
  "hidden_value": "*****",
  "key_type": "string",
  "searchable_value": "group1"
}

Parâmentros

Nome parâmetro Descrição
host_id
opcional

ID do host

Validations:

  • Must be a String

hostgroup_id
opcional

ID do grupo de host

Validations:

  • Must be a String

domain_id
opcional

ID para um domínio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID do sistema operacional

Validations:

  • Must be a String

location_id
opcional

ID de localização

Validations:

  • Must be a String

organization_id
opcional

ID de organização

Validations:

  • Must be a String

id
requerido

ID do parametrô

Validations:

  • Must be a String

subnet_id
opcional

ID da subrede

Validations:

  • Must be a String


DELETE /api/hosts/:host_id/parameters
Apagar todos os parâmetros aninhados para um host

DELETE /api/hostgroups/:hostgroup_id/parameters
Apagar todos os parâmetros aninhados para um grupo de hosts

DELETE /api/domains/:domain_id/parameters
Apagar todos os parâmetros aninhados para um domínio

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Apagar todos os parâmetros aninhados para um sistema operacional

DELETE /api/locations/:location_id/parameters
Apagar todos os parâmetros aninhados para uma localização

DELETE /api/organizations/:organization_id/parameters
Apagar todos os parâmetros aninhados para uma organização

DELETE /api/subnets/:subnet_id/parameters
Apagar todos os parametros aninhados para uma sub-rede

Exemplos

DELETE /api/hosts/host2698/parameters
{
  "parameter": {}
}
200
[

]

Parâmentros

Nome parâmetro Descrição
host_id
opcional

ID do host

Validations:

  • Must be a String

hostgroup_id
opcional

ID do grupo de host

Validations:

  • Must be a String

domain_id
opcional

ID para um domínio

Validations:

  • Must be a String

operatingsystem_id
opcional

ID do sistema operacional

Validations:

  • Must be a String

location_id
opcional

ID de localização

Validations:

  • Must be a String

organization_id
opcional

ID de organização

Validations:

  • Must be a String

subnet_id
opcional

ID da subrede

Validations:

  • Must be a String