GET /api/common_parameters
Listar todos os parâmetros globais

Parâmentros

Nome parâmetro Descrição
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

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

GET /api/common_parameters/:id
Mostrar um parâmetro global

Parâmentros

Nome parâmetro Descrição
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

show_hidden
opcional

Exibir valores ocultos

Validations:

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

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/common_parameters
Criar um parâmetro global

Parâmentros

Nome parâmetro Descrição
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

common_parameter
requerido

Validations:

  • Must be a Hash

common_parameter[name]
requerido

Validations:

  • Must be a String

common_parameter[value]
requerido

Validations:

  • Must be a String

common_parameter[parameter_type]
requerido

Type of value

Validations:

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

common_parameter[hidden_value]
opcional , nulo permitido

Validations:

  • Must be one of: true, false.


PUT /api/common_parameters/:id
Atualizar um parâmetro global

Parâmentros

Nome parâmetro Descrição
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.

common_parameter
requerido

Validations:

  • Must be a Hash

common_parameter[name]
opcional

Validations:

  • Must be a String

common_parameter[value]
opcional

Validations:

  • Must be a String

common_parameter[parameter_type]
opcional

Type of value

Validations:

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

common_parameter[hidden_value]
opcional , nulo permitido

Validations:

  • Must be one of: true, false.


DELETE /api/common_parameters/:id
Apagar um parâmetro global

Parâmentros

Nome parâmetro Descrição
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.