GET /api/templates/:template_id/template_inputs
List template inputs

Params

Param name Description
template_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.

search
optional

filter results

Validations:

  • Must be String

order
optional

sort results

Validations:

  • Must be String

page
optional

paginate results

Validations:

  • Must be String

per_page
optional

number of entries per request

Validations:

  • Must be String


GET /api/templates/:template_id/template_inputs/:id
Show template input details

Params

Param name Description
template_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.

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.


POST /api/templates/:template_id/template_inputs
Create a template input

Params

Param name Description
template_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.

template_input
required

Validations:

  • Must be a Hash

template_input[name]
required

Input name

Validations:

  • Must be String

template_input[description]
optional , nil allowed

Input description

Validations:

  • Must be String

template_input[required]
optional , nil allowed

Input is required

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

template_input[advanced]
optional , nil allowed

Input is advanced

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

template_input[input_type]
required

Input type

Validations:

  • Must be one of: user, fact, variable, puppet_parameter.

template_input[fact_name]
optional , nil allowed

Fact name, used when input type is fact

Validations:

  • Must be String

template_input[variable_name]
optional , nil allowed

Variable name, used when input type is variable

Validations:

  • Must be String

template_input[puppet_parameter_class]
optional , nil allowed

Puppet class name, used when input type is puppet_parameter

Validations:

  • Must be String

template_input[puppet_parameter_name]
optional , nil allowed

Puppet parameter name, used when input type is puppet_parameter

Validations:

  • Must be String

template_input[options]
optional , nil allowed

Selectable values for user inputs

Validations:

  • Must be an array of any type


DELETE /api/templates/:template_id/template_inputs/:id
Delete a template input

Params

Param name Description
template_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.

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.


PUT /api/templates/:template_id/template_inputs/:id
Update a template input

Params

Param name Description
template_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.

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.

template_input
required

Validations:

  • Must be a Hash

template_input[name]
optional

Input name

Validations:

  • Must be String

template_input[description]
optional , nil allowed

Input description

Validations:

  • Must be String

template_input[required]
optional , nil allowed

Input is required

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

template_input[advanced]
optional , nil allowed

Input is advanced

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

template_input[input_type]
optional

Input type

Validations:

  • Must be one of: user, fact, variable, puppet_parameter.

template_input[fact_name]
optional , nil allowed

Fact name, used when input type is fact

Validations:

  • Must be String

template_input[variable_name]
optional , nil allowed

Variable name, used when input type is variable

Validations:

  • Must be String

template_input[puppet_parameter_class]
optional , nil allowed

Puppet class name, used when input type is puppet_parameter

Validations:

  • Must be String

template_input[puppet_parameter_name]
optional , nil allowed

Puppet parameter name, used when input type is puppet_parameter

Validations:

  • Must be String

template_input[options]
optional , nil allowed

Selectable values for user inputs

Validations:

  • Must be an array of any type