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

パラメーター

パラメーター名 記述
id
必須

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

パラメーター

パラメーター名 記述
search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.


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

パラメーター

パラメーター名 記述
id
必須

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

パラメーター

パラメーター名 記述
salt_variable
必須

Validations:

  • Must be a Hash

salt_variable[variable]
必須

変数の名前

Validations:

  • Must be a String

salt_variable[salt_state_id]
必須

State ID

Validations:

  • Must be a number.

salt_variable[default_value]
任意 , nil可

変数のデフォルト値

Validations:

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

salt_variable[hidden_value]
任意 , nil可

有効な場合はパラメーターが UI で非表示になります

Validations:

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

salt_variable[override_value_order]
任意 , nil可

値が解決される順序

Validations:

  • Must be a String

salt_variable[description]
任意 , nil可

変数の説明

Validations:

  • Must be a String

salt_variable[validator_type]
任意 , nil可

検証値のタイプ

Validations:

  • Must be one of: regexp, list.

salt_variable[validator_rule]
任意 , nil可

パラメーター値の特定の値を適用するために使用されます

Validations:

  • Must be a String

salt_variable[variable_type]
任意 , nil可

変数値のタイプ

Validations:

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

salt_variable[merge_overrides]
任意 , nil可

一致するすべての値のマージ (配列/ハッシュタイプのみ)

Validations:

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

salt_variable[merge_default]
任意 , nil可

一致するすべての値をマージするときにデフォルト値を含めます

Validations:

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

salt_variable[avoid_duplicates]
任意 , nil可

重複する値の削除 (配列タイプのみ)

Validations:

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


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

パラメーター

パラメーター名 記述
id
必須

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
必須

Validations:

  • Must be a Hash

salt_variable[variable]
任意

変数の名前

Validations:

  • Must be a String

salt_variable[salt_state_id]
任意

State ID

Validations:

  • Must be a number.

salt_variable[default_value]
任意 , nil可

変数のデフォルト値

Validations:

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

salt_variable[hidden_value]
任意 , nil可

有効な場合はパラメーターが UI で非表示になります

Validations:

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

salt_variable[override_value_order]
任意 , nil可

値が解決される順序

Validations:

  • Must be a String

salt_variable[description]
任意 , nil可

変数の説明

Validations:

  • Must be a String

salt_variable[validator_type]
任意 , nil可

検証値のタイプ

Validations:

  • Must be one of: regexp, list.

salt_variable[validator_rule]
任意 , nil可

パラメーター値の特定の値を適用するために使用されます

Validations:

  • Must be a String

salt_variable[variable_type]
任意 , nil可

変数値のタイプ

Validations:

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

salt_variable[merge_overrides]
任意 , nil可

一致するすべての値のマージ (配列/ハッシュタイプのみ)

Validations:

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

salt_variable[merge_default]
任意 , nil可

一致するすべての値をマージするときにデフォルト値を含めます

Validations:

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

salt_variable[avoid_duplicates]
任意 , nil可

重複する値の削除 (配列タイプのみ)

Validations:

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