GET /ansible/api/ansible_variables/:id
Show variable

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

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 /ansible/api/ansible_variables
Vypsat Ansible proměnné

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

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, 'all' to return all results

Validations:

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

Search fields

Název kolonky Typ Možné hodnoty
ansible_role
avoid_duplicates true, false
imported true, false
key
merge_default true, false
merge_overrides true, false
name
override true, false
parameter

DELETE /ansible/api/ansible_variables/:id
Smazat Ansible proměnnou

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

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 /ansible/api/ansible_variables
Vytvořit Ansible proměnnou

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

ansible_variable
Required

Validations:

  • Must be a Hash

ansible_variable[variable]
Required

Název proměnné

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
Required

Identif. role

Validations:

  • Must be a number.

ansible_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

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

ansible_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

ansible_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

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

ansible_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

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

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

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

Při slučování všech odpovídajících hodnota zahrnout výchozí hodnoty

Validations:

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

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

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

Zda hodnotu přepsat nebo ne

Validations:

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


PUT /ansible/api/ansible_variables/:id
Aktualizuje Ansible proměnné

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

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.

ansible_variable
Required

Validations:

  • Must be a Hash

ansible_variable[variable]
Optional

Název proměnné

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
Optional

Identif. role

Validations:

  • Must be a number.

ansible_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

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

ansible_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

ansible_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

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

ansible_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

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

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

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

Při slučování všech odpovídajících hodnota zahrnout výchozí hodnoty

Validations:

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

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

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

Zda hodnotu přepsat nebo ne

Validations:

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


PUT /ansible/api/ansible_variables/import
Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles

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

proxy_id
Required

Smart Proxy to import from

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 /ansible/api/ansible_variables/obsolete
Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles

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

proxy_id
Required

Smart Proxy to import from

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.