GET /api/smart_variables
List all smart variables

GET /api/hosts/:host_id/smart_variables
List of smart variables for a specific host

GET /api/hostgroups/:hostgroup_id/smart_variables
List of smart variables for a specific host group

GET /api/puppetclasses/:puppetclass_id/smart_variables
List of smart variables for a specific Puppet class

Params

Param name Description
host_id
optional

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

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

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

filter results


Value: Must be String
order
optional

sort results


Value: Must be String
page
optional

paginate results


Value: Must be String
per_page
optional

number of entries per request


Value: Must be String

GET /api/smart_variables/:id
Show a smart variable

Params

Param name Description
id
required

Value: 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/smart_variables
Create a smart variable

Params

Param name Description
smart_variable
required

Value: Must be a Hash
smart_variable[variable]
required

Name of variable


Value: Must be String
smart_variable[puppetclass_id]
optional , nil allowed

Puppet class ID


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

Default value of variable


Value: Must be String
smart_variable[override_value_order]
optional , nil allowed

The order in which values are resolved


Value: Must be String
smart_variable[description]
optional , nil allowed

Description of variable


Value: Must be String
smart_variable[validator_type]
optional , nil allowed

Types of validation values


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

Used to enforce certain values for the parameter values


Value: Must be String
smart_variable[variable_type]
optional , nil allowed

Types of variable values


Value: 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)


Value: Must be 'true' or 'false'
smart_variable[avoid_duplicates]
optional , nil allowed

Remove duplicate values (only array type)


Value: Must be 'true' or 'false'

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

Params

Param name Description
id
required

Value: 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

Value: Must be a Hash
smart_variable[variable]
optional

Name of variable


Value: Must be String
smart_variable[puppetclass_id]
optional , nil allowed

Puppet class ID


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

Default value of variable


Value: Must be String
smart_variable[override_value_order]
optional , nil allowed

The order in which values are resolved


Value: Must be String
smart_variable[description]
optional , nil allowed

Description of variable


Value: Must be String
smart_variable[validator_type]
optional , nil allowed

Types of validation values


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

Used to enforce certain values for the parameter values


Value: Must be String
smart_variable[variable_type]
optional , nil allowed

Types of variable values


Value: 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)


Value: Must be 'true' or 'false'
smart_variable[avoid_duplicates]
optional , nil allowed

Remove duplicate values (only array type)


Value: Must be 'true' or 'false'

DELETE /api/smart_variables/:id
Delete a smart variable

Params

Param name Description
id
required

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