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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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

filtrera resultat

Validations:

  • Must be a String

order
optional

sortera resultat

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

antal poster per begäran

Validations:

  • Must be a String


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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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 a String

template_input[description]
optional , nil allowed

Input description

Validations:

  • Must be a String

template_input[required]
optional , nil allowed

Input is required

Validations:

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

template_input[advanced]
optional , nil allowed

Input is advanced

Validations:

  • Must be one of: true, false, 1, 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 a String

template_input[variable_name]
optional , nil allowed

Variable name, used when input type is variable

Validations:

  • Must be a String

template_input[puppet_parameter_class]
optional , nil allowed

Puppet class name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[puppet_parameter_name]
optional , nil allowed

Puppet parameter name, used when input type is puppet_parameter

Validations:

  • Must be a 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
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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 a String

template_input[description]
optional , nil allowed

Input description

Validations:

  • Must be a String

template_input[required]
optional , nil allowed

Input is required

Validations:

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

template_input[advanced]
optional , nil allowed

Input is advanced

Validations:

  • Must be one of: true, false, 1, 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 a String

template_input[variable_name]
optional , nil allowed

Variable name, used when input type is variable

Validations:

  • Must be a String

template_input[puppet_parameter_class]
optional , nil allowed

Puppet class name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[puppet_parameter_name]
optional , nil allowed

Puppet parameter name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[options]
optional , nil allowed

Selectable values for user inputs

Validations:

  • Must be an array of any type