GET /api/smart_variables/:smart_variable_id/override_values
List of override values for a specific smart variable

GET /api/smart_class_parameters/:smart_class_parameter_id/override_values
List of override values for a specific smart class parameter

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

smart_variable_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

smart_class_parameter_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

show_hidden
optional

Display hidden values

Validations:

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

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String


GET /api/smart_variables/:smart_variable_id/override_values/:id
Show an override value for a specific smart variable

GET /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id
Show an override value for a specific smart class parameter

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

smart_variable_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

smart_class_parameter_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

show_hidden
optional

Display hidden values

Validations:

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


POST /api/smart_variables/:smart_variable_id/override_values
Create an override value for a specific smart variable

POST /api/smart_class_parameters/:smart_class_parameter_id/override_values
Create an override value for a specific smart class parameter

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

smart_variable_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

smart_class_parameter_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

override_value
required

Validations:

  • Hash

override_value[match]
required

Override match

Validations:

  • String

override_value[value]
optional , nil allowed

Override value, required if omit is false

Validations:

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

override_value[use_puppet_default]
optional , nil allowed

Deprecated, please use omit

Validations:

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

override_value[omit]
optional , nil allowed

Foreman will not send this parameter in classification output, replaces use_puppet_default

Validations:

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


PUT /api/smart_variables/:smart_variable_id/override_values/:id
Update an override value for a specific smart variable

PUT /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id
Update an override value for a specific smart class parameter

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

smart_variable_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

smart_class_parameter_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

override_value
required

Validations:

  • Hash

override_value[match]
optional

Override match

Validations:

  • String

override_value[value]
optional , nil allowed

Override value, required if omit is false

Validations:

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

override_value[use_puppet_default]
optional , nil allowed

Deprecated, please use omit

Validations:

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

override_value[omit]
optional , nil allowed

Foreman will not send this parameter in classification output, replaces use_puppet_default

Validations:

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


DELETE /api/smart_variables/:smart_variable_id/override_values/:id
Delete an override value for a specific smart variable

DELETE /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id
Delete an override value for a specific smart class parameter

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

smart_variable_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

smart_class_parameter_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..