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 , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Puppet class ID


Value: Must be a number.
smart_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Default value of variable


Value: Must be String
smart_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

I vilken ordning värden slås upp


Value: Must be String
smart_variable[description]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Description of variable


Value: Must be String
smart_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Types of validation values


Value: Must be one of: regexp, list.
smart_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Used to enforce certain values for the parameter values


Value: Must be String
smart_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Types of variable values


Value: Must be one of: string, boolean, integer, real, array, hash, yaml, json.
smart_variable[merge_overrides]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Merge all matching values (only array/hash type)


Value: Must be 'true' or 'false'
smart_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Puppet class ID


Value: Must be a number.
smart_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Default value of variable


Value: Must be String
smart_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

I vilken ordning värden slås upp


Value: Must be String
smart_variable[description]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Description of variable


Value: Must be String
smart_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Types of validation values


Value: Must be one of: regexp, list.
smart_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Used to enforce certain values for the parameter values


Value: Must be String
smart_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Types of variable values


Value: Must be one of: string, boolean, integer, real, array, hash, yaml, json.
smart_variable[merge_overrides]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Merge all matching values (only array/hash type)


Value: Must be 'true' or 'false'
smart_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

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.