GET /api/smart_class_parameters
List all smart class parameters

GET /api/hosts/:host_id/smart_class_parameters
List of smart class parameters for a specific host

GET /api/hostgroups/:hostgroup_id/smart_class_parameters
List of smart class parameters for a specific host group

GET /api/puppetclasses/:puppetclass_id/smart_class_parameters
List of smart class parameters for a specific Puppet class

GET /api/environments/:environment_id/smart_class_parameters
List of smart class parameters for a specific environment

GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters
List of smart class parameters for a specific environment/Puppet class combination

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.
environment_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_class_parameters/:id
Show a smart class parameter

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.

PUT /api/smart_class_parameters/:id
Update a smart class parameter

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_class_parameter
required

Value: Must be a Hash
smart_class_parameter[override]
optional

Whether the smart class parameter value is managed by Foreman


Value: Must be 'true' or 'false'
smart_class_parameter[description]
optional

Description of smart class


Value: Must be String
smart_class_parameter[default_value]
optional

Value to use when there is no match


Value: Must be String
smart_class_parameter[use_puppet_default]
optional

Do not send this parameter via the ENC. Puppet will use the value defined in the Puppet manifest for this parameter


Value: Must be 'true' or 'false'
smart_class_parameter[path]
optional

The order in which values are resolved


Value: Must be String
smart_class_parameter[validator_type]
optional

Types of validation values


Value: Must be one of: regexp, list.
smart_class_parameter[validator_rule]
optional

Used to enforce certain values for the parameter values


Value: Must be String
smart_class_parameter[override_value_order]
optional

The order in which values are resolved


Value: Must be String
smart_class_parameter[parameter_type]
optional

Types of variable values


Value: Must be one of: string, boolean, integer, real, array, hash, yaml, json.
smart_class_parameter[required]
optional

If true, will raise an error if there is no default value and no matcher provide a value


Value: Must be 'true' or 'false'
smart_class_parameter[merge_overrides]
optional

Merge all matching values (only array/hash type)


Value: Must be 'true' or 'false'
smart_class_parameter[avoid_duplicates]
optional

Remove duplicate values (only array type)


Value: Must be 'true' or 'false'