Templates

Get rich parameters by template version

Changed on
get/api/v2/templateversions/{templateversion}/rich-parameters

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/templateversions/{templateversion}/rich-parameters
  • Auth
    API key in header Coder-Session-Token

Path parameters

templateversionstring uuid required

Template version ID

Response

OK

default_valuestring
descriptionstring
description_plaintextstring
display_namestring
ephemeralboolean
form_type'' | 'radio' | 'dropdown' | 'input' | 'textarea' | 'slider' | 'checkbox' | 'switch' | 'tag-select' | 'multi-select' | 'error'

FormType has an enum value of empty string, "". Keep the leading comma in the enums struct tag.

iconstring
mutableboolean
namestring
requiredboolean
type'string' | 'number' | 'bool' | 'list(string)'
validation_errorstring
validation_maxinteger
validation_mininteger
validation_monotonic'increasing' | 'decreasing'
validation_regexstring

Changes