Common parameters

>>>

GET /api/common_parameters
List all global parameters

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
show_hidden
opzionale

Display hidden values

Validations:

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

filtra i risultati

Validations:

  • Must be a String
order
opzionale

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
opzionale

Numero pagina, iniziando da 1

Validations:

  • Must be a number.
per_page
opzionale

Numero di risultati per pagina da ritornare

Validations:

  • Must be a number.

Search fields

Field name Tipo Possible values
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
Mostra un parametro globale

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
show_hidden
opzionale

Display hidden values

Validations:

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

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
Crea un parametro globale

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
common_parameter
richiesto

Validations:

  • Must be a Hash
common_parameter[name]
richiesto

Validations:

  • Must be a String
common_parameter[value]
richiesto

Validations:

  • Must be a String
common_parameter[parameter_type]
richiesto

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
common_parameter[hidden_value]
opzionale , consentito nil

Validations:

  • Must be one of: true, false.
>>>

PUT /api/common_parameters/:id
Aggiorna un parametro globale

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
id
richiesto

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
richiesto

Validations:

  • Must be a Hash
common_parameter[name]
opzionale

Validations:

  • Must be a String
common_parameter[value]
opzionale

Validations:

  • Must be a String
common_parameter[parameter_type]
opzionale

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
common_parameter[hidden_value]
opzionale , consentito nil

Validations:

  • Must be one of: true, false.
>>>

DELETE /api/common_parameters/:id
Cancella un parametro globale

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
id
richiesto

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.