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

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
richiesto

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
opzionale

filtra i risultati

Validations:

  • Must be a String

order
opzionale

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opzionale

Numero pagina, iniziando da 1

Validations:

  • Must be a number.

per_page
opzionale

Numero di risultati per pagina da ritornare

Validations:

  • Must be a number.

Search fields

Field name Tipo Possible values
input_type
name

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

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
richiesto

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
richiesto

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

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
richiesto

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
richiesto

Validations:

  • Must be a Hash

template_input[name]
richiesto

Input name

Validations:

  • Must be a String

template_input[description]
opzionale , consentito nil

Input description

Validations:

  • Must be a String

template_input[required]
opzionale , consentito nil

Input is required

Validations:

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

template_input[advanced]
opzionale , consentito nil

Input is advanced

Validations:

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

template_input[input_type]
richiesto

Input type

Validations:

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

template_input[fact_name]
opzionale , consentito nil

Fact name, used when input type is fact

Validations:

  • Must be a String

template_input[variable_name]
opzionale , consentito nil

Variable name, used when input type is variable

Validations:

  • Must be a String

template_input[puppet_class_name]
opzionale , consentito nil

Puppet class name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[puppet_parameter_name]
opzionale , consentito nil

Puppet parameter name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[options]
opzionale , consentito nil

Selectable values for user inputs

Validations:

  • Must be an array of any type

template_input[default]
opzionale , consentito nil

Default value for user input

Validations:

  • Must be a String

template_input[hidden_value]
opzionale , consentito nil

The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords

Validations:

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

template_input[value_type]
opzionale , consentito nil

Value type, defaults to plain

Validations:

  • Must be one of: plain, search, date.

template_input[resource_type]
opzionale , consentito nil

For values of type search, this is the resource the value searches in

Validations:

  • Must be one of: .


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

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
richiesto

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
richiesto

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

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
richiesto

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
richiesto

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
richiesto

Validations:

  • Must be a Hash

template_input[name]
opzionale

Input name

Validations:

  • Must be a String

template_input[description]
opzionale , consentito nil

Input description

Validations:

  • Must be a String

template_input[required]
opzionale , consentito nil

Input is required

Validations:

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

template_input[advanced]
opzionale , consentito nil

Input is advanced

Validations:

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

template_input[input_type]
opzionale

Input type

Validations:

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

template_input[fact_name]
opzionale , consentito nil

Fact name, used when input type is fact

Validations:

  • Must be a String

template_input[variable_name]
opzionale , consentito nil

Variable name, used when input type is variable

Validations:

  • Must be a String

template_input[puppet_class_name]
opzionale , consentito nil

Puppet class name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[puppet_parameter_name]
opzionale , consentito nil

Puppet parameter name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[options]
opzionale , consentito nil

Selectable values for user inputs

Validations:

  • Must be an array of any type

template_input[default]
opzionale , consentito nil

Default value for user input

Validations:

  • Must be a String

template_input[hidden_value]
opzionale , consentito nil

The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords

Validations:

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

template_input[value_type]
opzionale , consentito nil

Value type, defaults to plain

Validations:

  • Must be one of: plain, search, date.

template_input[resource_type]
opzionale , consentito nil

For values of type search, this is the resource the value searches in

Validations:

  • Must be one of: .