Template inputs

>>>

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

Examples

GET /api/templates/1007981709/template_inputs
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "template_id": 1007981709,
      "fact_name": null,
      "variable_name": null,
      "puppet_parameter_name": null,
      "puppet_class_name": null,
      "description": null,
      "required": false,
      "default": null,
      "hidden_value": false,
      "id": 1,
      "name": "Template input 5",
      "input_type": "user",
      "options": null
    }
  ]
}

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.
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
input_type string
name string
>>>

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

Examples

GET /api/templates/1007981712-report_template66/template_inputs/4
200
{
  "template_id": 1007981712,
  "fact_name": null,
  "variable_name": null,
  "puppet_parameter_name": null,
  "puppet_class_name": null,
  "description": null,
  "required": false,
  "default": null,
  "hidden_value": false,
  "id": 4,
  "name": "Template input 8",
  "input_type": "user",
  "options": null
}

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.
>>>

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

Examples

POST /api/templates/1007981714-report_template68/template_inputs
{
  "template_input": {
    "name": "is_potato",
    "input_type": "user",
    "options": [
      "true",
      "false"
    ]
  }
}
201
{
  "template_id": 1007981714,
  "fact_name": null,
  "variable_name": null,
  "puppet_parameter_name": null,
  "puppet_class_name": null,
  "description": null,
  "required": false,
  "default": null,
  "hidden_value": false,
  "id": 7,
  "name": "is_potato",
  "input_type": "user",
  "options": [
    "true",
    "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.
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 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[puppet_class_name]
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
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.
>>>

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

Examples

DELETE /api/templates/1007981713-report_template67/template_inputs/5
{
  "template_input": {}
}
200
{
  "id": 5,
  "name": "Template input 9",
  "required": false,
  "input_type": "user",
  "fact_name": null,
  "variable_name": null,
  "puppet_class_name": null,
  "puppet_parameter_name": null,
  "description": null,
  "template_id": 1007981713,
  "created_at": "2021-05-18T15:56:20.027Z",
  "updated_at": "2021-05-18T15:56:20.027Z",
  "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.
>>>

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

Examples

PUT /api/templates/1007981710-report_template64/template_inputs/2
{
  "template_input": {
    "name": ""
  }
}
422
{
  "error": {
    "id": 2,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

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, puppet_parameter.
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[puppet_class_name]
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
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.