GET /salt/api/salt_variables/:id
Show variable

Params

Param Name Description
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.


GET /salt/api/salt_variables
List Salt variables

Params

Param Name Description
search
Optional

výsledky filtru

Validations:

  • Must be a String

order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
Optional

Číslo stránky, začíná od jedničky

Validations:

  • Must be a number.

per_page
Optional

Number of results per page to return

Validations:

  • Must be a number.


DELETE /salt/api/salt_variables/:id
Deletes Salt variable

Params

Param Name Description
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 /salt/api/salt_variables
Create Salt variable

Params

Param Name Description
salt_variable
Required

Validations:

  • Must be a Hash

salt_variable[variable]
Required

Název proměnné

Validations:

  • Must be a String

salt_variable[salt_state_id]
Required

State ID

Validations:

  • Must be a number.

salt_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Výchozí hodnota proměnné

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json

salt_variable[hidden_value]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

When enabled the parameter is hidden in the UI

Validations:

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

salt_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Pořadí ve kterém jsou hodnoty řešeny

Validations:

  • Must be a String

salt_variable[description]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Popis proměnné

Validations:

  • Must be a String

salt_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Typy hodnot ověřování

Validations:

  • Must be one of: regexp, list.

salt_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Used to enforce certain values for the parameter values

Validations:

  • Must be a String

salt_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Typy hodnot proměnné

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

salt_variable[merge_overrides]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Merge all matching values (only array/hash type)

Validations:

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

salt_variable[merge_default]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Include default value when merging all matching values

Validations:

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

salt_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Remove duplicate values (only array type)

Validations:

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


PUT /salt/api/salt_variables/:id
Updates Salt variable

Params

Param Name Description
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.

salt_variable
Required

Validations:

  • Must be a Hash

salt_variable[variable]
Optional

Název proměnné

Validations:

  • Must be a String

salt_variable[salt_state_id]
Optional

State ID

Validations:

  • Must be a number.

salt_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Výchozí hodnota proměnné

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json

salt_variable[hidden_value]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

When enabled the parameter is hidden in the UI

Validations:

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

salt_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Pořadí ve kterém jsou hodnoty řešeny

Validations:

  • Must be a String

salt_variable[description]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Popis proměnné

Validations:

  • Must be a String

salt_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Typy hodnot ověřování

Validations:

  • Must be one of: regexp, list.

salt_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Used to enforce certain values for the parameter values

Validations:

  • Must be a String

salt_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Typy hodnot proměnné

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

salt_variable[merge_overrides]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Merge all matching values (only array/hash type)

Validations:

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

salt_variable[merge_default]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Include default value when merging all matching values

Validations:

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

salt_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Remove duplicate values (only array type)

Validations:

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