Reference

custom

Fields of a custom variable.

Example

{
  "name": "env",
  "type": "custom",
  "options": [
    "prod",
    "staging"
  ]
}

Field	Type	Description
`name` (required)	`variableName`	Referenced in queries as $name, ${name} or ${name:format}.
`label`	`string`
`description`	`string`
`hide`	`"label"`, `"variable"`
`skipUrlSync`	`boolean`	The variable’s value is not read from or written to the URL.
`type` (required)	`"custom"`
`options` (required)	array of `string` or `object`	At most 200 items.
`allowCustomValue`	`boolean`
`multi`	`boolean`
`includeAll`	`boolean`
`allValue`	`string`
`default`	`selection`	Default selection: one value, several for a multi variable, or $__all.