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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
wymagany

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
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String

order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.

per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ Possible values
input_type
name

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
wymagany

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
wymagany

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
wymagany

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
wymagany

Validations:

  • Must be a Hash

template_input[name]
wymagany

Input name

Validations:

  • Must be a String

template_input[description]
opcjonalny , nil dopuszczalny

Input description

Validations:

  • Must be a String

template_input[required]
opcjonalny , nil dopuszczalny

Input is required

Validations:

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

template_input[advanced]
opcjonalny , nil dopuszczalny

Input is advanced

Validations:

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

template_input[input_type]
wymagany

Input type

Validations:

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

template_input[fact_name]
opcjonalny , nil dopuszczalny

Fact name, used when input type is fact

Validations:

  • Must be a String

template_input[variable_name]
opcjonalny , nil dopuszczalny

Variable name, used when input type is variable

Validations:

  • Must be a String

template_input[puppet_class_name]
opcjonalny , nil dopuszczalny

Puppet class name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[puppet_parameter_name]
opcjonalny , nil dopuszczalny

Puppet parameter name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[options]
opcjonalny , nil dopuszczalny

Selectable values for user inputs

Validations:

  • Must be an array of any type

template_input[default]
opcjonalny , nil dopuszczalny

Default value for user input

Validations:

  • Must be a String

template_input[hidden_value]
opcjonalny , nil dopuszczalny

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]
opcjonalny , nil dopuszczalny

Value type, defaults to plain

Validations:

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

template_input[resource_type]
opcjonalny , nil dopuszczalny

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
wymagany

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
wymagany

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
wymagany

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
wymagany

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
wymagany

Validations:

  • Must be a Hash

template_input[name]
opcjonalny

Input name

Validations:

  • Must be a String

template_input[description]
opcjonalny , nil dopuszczalny

Input description

Validations:

  • Must be a String

template_input[required]
opcjonalny , nil dopuszczalny

Input is required

Validations:

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

template_input[advanced]
opcjonalny , nil dopuszczalny

Input is advanced

Validations:

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

template_input[input_type]
opcjonalny

Input type

Validations:

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

template_input[fact_name]
opcjonalny , nil dopuszczalny

Fact name, used when input type is fact

Validations:

  • Must be a String

template_input[variable_name]
opcjonalny , nil dopuszczalny

Variable name, used when input type is variable

Validations:

  • Must be a String

template_input[puppet_class_name]
opcjonalny , nil dopuszczalny

Puppet class name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[puppet_parameter_name]
opcjonalny , nil dopuszczalny

Puppet parameter name, used when input type is puppet_parameter

Validations:

  • Must be a String

template_input[options]
opcjonalny , nil dopuszczalny

Selectable values for user inputs

Validations:

  • Must be an array of any type

template_input[default]
opcjonalny , nil dopuszczalny

Default value for user input

Validations:

  • Must be a String

template_input[hidden_value]
opcjonalny , nil dopuszczalny

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]
opcjonalny , nil dopuszczalny

Value type, defaults to plain

Validations:

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

template_input[resource_type]
opcjonalny , nil dopuszczalny

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

Validations:

  • Must be one of: .