PUT /api/smart_variables/:id
Update a smart variable

Examples

PUT /api/smart_variables/1018350796-YWYjBDRHmw
{
  "smart_variable": {
    "hidden_value": false
  }
}
200
{
  "description": null,
  "parameter_type": null,
  "variable_type": null,
  "hidden_value?": false,
  "validator_type": null,
  "validator_rule": null,
  "override_value_order": "fqdn\nhostgroup\nos\ndomain",
  "merge_overrides": false,
  "merge_default": false,
  "avoid_duplicates": false,
  "puppetclass_id": 980190962,
  "puppetclass_name": "base",
  "created_at": "2018-11-15 19:01:55 UTC",
  "updated_at": "2018-11-15 19:01:55 UTC",
  "variable": "YWYjBDRHmw",
  "id": 1018350796,
  "default_value": null,
  "override_values_count": 0,
  "override_values": []
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

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.
smart_variable
required

Validations:

  • Must be a Hash
smart_variable[variable]
optional

Name of variable

Validations:

  • Must be a String
smart_variable[puppetclass_id]
optional , nil allowed

Puppet class ID

Validations:

  • Must be a number.
smart_variable[default_value]
optional , nil allowed

Default value of variable

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json
smart_variable[hidden_value]
optional , nil allowed

When enabled the parameter is hidden in the UI

Validations:

  • Must be one of: true, false, 1, 0
smart_variable[override_value_order]
optional , nil allowed

The order in which values are resolved

Validations:

  • Must be a String
smart_variable[description]
optional , nil allowed

Description of variable

Validations:

  • Must be a String
smart_variable[validator_type]
optional , nil allowed

Types of validation values

Validations:

  • Must be one of: regexp, list.
smart_variable[validator_rule]
optional , nil allowed

Used to enforce certain values for the parameter values

Validations:

  • Must be a String
smart_variable[variable_type]
optional , nil allowed

Types of variable values

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
smart_variable[merge_overrides]
optional , nil allowed

Merge all matching values (only array/hash type)

Validations:

  • Must be one of: true, false, 1, 0
smart_variable[merge_default]
optional , nil allowed

Include default value when merging all matching values

Validations:

  • Must be one of: true, false, 1, 0
smart_variable[avoid_duplicates]
optional , nil allowed

Remove duplicate values (only array type)

Validations:

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