GET /api/common_parameters
List all global parameters

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

show_hidden
optional

Mostra els valors ocults

Validations:

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

search
optional

filtra els resultats

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Nombre de resultats per pàgina a retornar

Validations:

  • Must be a number.

Search fields

Field name Tipus 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 paràmetre global

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

show_hidden
optional

Mostra els valors ocults

Validations:

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

id
required

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 paràmetre global

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

common_parameter
required

Validations:

  • Must be a Hash

common_parameter[name]
required

Validations:

  • Must be a String

common_parameter[value]
required

Validations:

  • Must be a String

common_parameter[parameter_type]
required

Type of value

Validations:

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

common_parameter[hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false.


PUT /api/common_parameters/:id
Actualitza un paràmetre global

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

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
required

Validations:

  • Must be a Hash

common_parameter[name]
optional

Validations:

  • Must be a String

common_parameter[value]
optional

Validations:

  • Must be a String

common_parameter[parameter_type]
optional

Type of value

Validations:

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

common_parameter[hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false.


DELETE /api/common_parameters/:id
Suprimeix un paràmetre global

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

Validations:

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