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
List Ansible variables

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

필터 결과

Validations:

  • Must be a String

order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
Optional

1 부터 페이지 번호

Validations:

  • Must be a number.

per_page
Optional

반환할 페이지 당 결과 수

Validations:

  • Must be a number.

Search fields

Field name 유형 Possible values
ansible_role string
avoid_duplicates true, false
imported true, false
key string
merge_default true, false
merge_overrides true, false
name string
override true, false
parameter string

DELETE /ansible/api/ansible_variables/:id
Deletes Ansible 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.


POST /ansible/api/ansible_variables
Create Ansible 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

ansible_variable
Required

Validations:

  • Must be a Hash

ansible_variable[variable]
Required

Name of variable

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
Required

Role ID

Validations:

  • Must be a number.

ansible_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Default value of variable

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: ko.apipie.nil_allowed">Nil Allowed</span>

활성화된 경우 매개 변수가 UI에서 숨겨집니다.

Validations:

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

ansible_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

값이 해결되는 순서

Validations:

  • Must be a String

ansible_variable[description]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Description of variable

Validations:

  • Must be a String

ansible_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

검증 값의 유형

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

특정 값을 매개 변수 값에 적용하는 데 사용됩니다.

Validations:

  • Must be a String

ansible_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

변수 값의 유형

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: ko.apipie.nil_allowed">Nil Allowed</span>

일치하는 모든 값 병합(배열/해시 유형만)

Validations:

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

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

일치하는 모든 값을 병합할 때 기본값 포함

Validations:

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

ansible_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

중복 값 삭제(배열 유형만)

Validations:

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

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

Whether to override variable or not

Validations:

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


PUT /ansible/api/ansible_variables/:id
Updates Ansible 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.

ansible_variable
Required

Validations:

  • Must be a Hash

ansible_variable[variable]
Optional

Name of variable

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
Optional

Role ID

Validations:

  • Must be a number.

ansible_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Default value of variable

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: ko.apipie.nil_allowed">Nil Allowed</span>

활성화된 경우 매개 변수가 UI에서 숨겨집니다.

Validations:

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

ansible_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

값이 해결되는 순서

Validations:

  • Must be a String

ansible_variable[description]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Description of variable

Validations:

  • Must be a String

ansible_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

검증 값의 유형

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

특정 값을 매개 변수 값에 적용하는 데 사용됩니다.

Validations:

  • Must be a String

ansible_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

변수 값의 유형

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: ko.apipie.nil_allowed">Nil Allowed</span>

일치하는 모든 값 병합(배열/해시 유형만)

Validations:

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

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

일치하는 모든 값을 병합할 때 기본값 포함

Validations:

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

ansible_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

중복 값 삭제(배열 유형만)

Validations:

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

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

Whether to override variable or not

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.