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

Examples

PUT /api/templates/1007981702-report_template139/template_inputs/1
{
  "template_input": {
    "name": "blah"
  }
}
200
{
  "id": 1,
  "name": "blah",
  "required": false,
  "input_type": "user",
  "fact_name": null,
  "variable_name": null,
  "puppet_class_name": null,
  "puppet_parameter_name": null,
  "description": null,
  "template_id": 1007981702,
  "created_at": "2021-09-01T13:15:34.083Z",
  "updated_at": "2021-09-01T13:15:34.140Z",
  "options": null,
  "advanced": false,
  "value_type": "plain",
  "resource_type": null,
  "default": null,
  "hidden_value": false
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

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.
template_input[fact_name]
optional , nil allowed

Fact name, used when input type is Fact value

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[options]
optional , nil allowed

Selectable values for user inputs

Validations:

  • Must be an array of any type
template_input[default]
optional , nil allowed

Default value for user input

Validations:

  • Must be a String
template_input[hidden_value]
optional , nil allowed

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]
optional , nil allowed

Value type, defaults to plain

Validations:

  • Must be one of: plain, search, date.
template_input[resource_type]
optional , nil allowed

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

Validations:

  • Must be one of: Architecture, Audit, AuthSource, Bookmark, ComputeProfile, ComputeResource, ConfigGroup, ConfigReport, Domain, Environment, ExternalUsergroup, FactValue, Filter, Host, HostClass, Hostgroup, HttpProxy, Image, KeyPair, Location, MailNotification, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Puppetclass, PuppetclassLookupKey, Realm, Report, ReportTemplate, Role, Setting, SmartProxy, SshKey, Subnet, User, Usergroup.